Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update heading levels for oracle blog post #4006

Merged
merged 2 commits into from
Jul 18, 2024
Merged

Conversation

igorkorenfeld
Copy link
Member

@igorkorenfeld igorkorenfeld commented Jul 17, 2024

Pull request summary

This PR shifts the headings in the databases blog post down one level, so that there is only a single h1 headings on the page. Our blog uses the post title as an h1, so I've shifted every other heading by 1 (h1-> h2, h2->h3, etc...). The exception to this this was the last two headings for the Conclusion and Special Thanks, which seemed like they were not part of the "Tutorial Part 2" section, but if that's incorrect happy to adjust.

Reminder - please do the following before assigning reviewer

  • Update readme
  • For frontend changes, ensure design review
  • For content changes beyond typos, add Ron Bronson as a reviewer

@igorkorenfeld igorkorenfeld requested a review from a team as a code owner July 17, 2024 14:05
@igorkorenfeld igorkorenfeld requested a review from beechnut July 17, 2024 14:06
Copy link
Contributor

@beechnut beechnut left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First of all, thanks for noticing this. Since this is a site-wide rule that's not listed anywhere as far as I can tell, we should build this check in to the site itself — I've added this to the 18F replatforming post-migration tasks.

I don't like the way the h4's look in the preview build — when scanning, they almost read as body text, and don't break the content up visually very well.

I think I'd significantly prefer knocking just the h1s down to h2s and leaving the rest as-is. It may not be as semantically correct, but having them stay larger better fulfills their purpose as separators.

@igorkorenfeld
Copy link
Member Author

Great, I've noticed the issue on a number of blog posts, so that'll be a good upgrade.

A possible alternative which would keep the semantic structure would be to style the h4 and h5 a bit larger in the blog posts?

@cantsin
Copy link
Member

cantsin commented Jul 17, 2024

We can have our cake and eat it too -- we can have semantically correct headers and sizes to match, but maybe this is a separate (a11y related?) ticket.

@igorkorenfeld
Copy link
Member Author

@beechnut I've update the styling for the headings to give the h4s and h5s a bit more prominence. The added benefit is that this better matches our intended design from last year too :)

Let me know how this looks to you

@igorkorenfeld igorkorenfeld requested a review from beechnut July 17, 2024 22:24
@beechnut
Copy link
Contributor

Wow, this looks great! Love the new styling! Approved!

@igorkorenfeld igorkorenfeld merged commit 3748e16 into main Jul 18, 2024
5 checks passed
@igorkorenfeld igorkorenfeld deleted the ik/db-post-headings branch July 18, 2024 14:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants