Docs SEO: Update Configuration section to improve search #24759
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
aimeeu
added
theme/docs
philrenaud
previously approved these changes
Dec 30, 2024
I'm following description templates created by the Education team so only time will tell :) |
boruszak
reviewed
Jan 3, 2025
There was a problem hiding this comment.
I left three suggestions on the first three descriptions with longer comments that explain the kinds of things we should be thinking about when updating descriptions for SEO. Your current edits are more focused on the style guide & active voice. But active voice isn't going to impact SEO.
This page from Google's SEO docs is their summary. The use quality descriptions subsection may be a useful resource.
aimeeu
changed the title
aimeeu
changed the title
boruszak
previously approved these changes
Jan 9, 2025
Co-authored-by: Jeff Boruszak <[email protected]>
boruszak
approved these changes
Jan 10, 2025
This was referenced Jan 10, 2025
Closed
aimeeu
added a commit
that referenced
this pull request
Jan 10, 2025
* Docs SEO: Update Configuration section to improve search engine opt CE-775 * Add enterprise only back to audit * Update descriptions and add intro paragraph * Fix typo * replace "below" and "see" * Apply suggestions from code review Co-authored-by: Jeff Boruszak <[email protected]> --------- Co-authored-by: Jeff Boruszak <[email protected]>
aimeeu
added a commit
that referenced
this pull request
Jan 10, 2025
…4835) * Docs SEO: Update Configuration section to improve search engine opt CE-775 * Add enterprise only back to audit * Update descriptions and add intro paragraph * Fix typo * replace "below" and "see" * Apply suggestions from code review --------- Co-authored-by: Jeff Boruszak <[email protected]>
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.
Description
descriptionupdates for DevDot search.descriptionbut in the body for better Google search indexing.page_titleand# <title>match.I mostly did not edit page content because that's out of scope for this effort. I did some small replacements tho ("see", "below"). Added a few links to pages that didn't have any (orphan pages).
A member of the Runtime Education team will review all SEO PRs.
Links
Jira: CE-775
Preview: https://nomad-git-ce775-hashicorp.vercel.app/nomad/docs/configuration
Contributor Checklist
changelog entry using the
make clcommand.ensure regressions will be caught.
and job configuration, please update the Nomad website documentation to reflect this. Refer to
the website README for docs guidelines. Please also consider whether the
change requires notes within the upgrade guide.
Reviewer Checklist
backporting document.
in the majority of situations. The main exceptions are long-lived feature branches or merges where
history should be preserved.
within the public repository.