Adjust heading levels on amazon-ecr page
#770
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bgonp
requested review from
codyjlandstrom,
pchico83,
ifbyol and
rlamana
as code owners
✅ Deploy Preview for okteto-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
bgonp
force-pushed
the
bgonp/amazon-ecr-headings
branch
2 times, most recently
from
cec3746
to
385a1e6
Compare
bgonp
force-pushed
the
bgonp/amazon-ecr-headings
branch
from
405bae1
to
a269ded
Compare
|
Yeah it can be confusing, but we should stick to only using H2, H3, etc. in our docs and only H1 for the Docusaurus generated header for SEO purposes. I believe the latest google search algos penalizes you if more than one H1 appears |
codyjlandstrom
approved these changes
Jun 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It looks like using
h1tags in the content of a page is discouraged, here is a conversation in the Docusaurus repository about it. Docusaurus doesn't inject an ID for first-level headings so we cannot have links directly to these sections. In the official docs they only talk about2,3and4levels, not mention about1AFAIK, but it looks like it generates some issues, e.g. the main title of the page just disappears if there are otherh1:I don't know if we have a policy about how to use headings but it would be great to agree on that and to fix other possible issues like this one that could exist in the project.
(The preview won't work until #769 is merged)