Merged
Conversation
Signed-off-by: Sharon Koech <sharon.koech@canonical.com>
Signed-off-by: Sharon Koech <sharon.koech@canonical.com>
|
LGTM! |
Collaborator
Author
|
Thank you, @SecondSkoll! |
5 tasks
skoech
added a commit
that referenced
this pull request
May 4, 2026
…723) # Description This PR adds HTML meta descriptions to some documentation files, building upon work started in #643. It also adds a checklist item in the PR template to ensure that the metadata descriptions are added to every new documentation page created and every modified file that doesn't already have it. ## Type of change Delete options that are not relevant. - Documentation update (change to documentation only) ## How has this been tested? Built documentation locally to make sure spelling and link checks are passing. ## Contributor checklist Please check that you have: - [ ] self-reviewed the code in this PR - [ ] added code comments, particularly in less straightforward areas - [ ] checked and added or updated relevant documentation - [ ] checked and added or updated relevant release notes - [ ] added tests to verify effectiveness of this change --------- Signed-off-by: Sharon Koech <sharon.koech@canonical.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
This PR adds HTML meta descriptions to a few pages (more to come) as part of our Traffic/SEO/analytics objectives. We need to generate description metadata for pages, and not rely on Sphinx to create it (or search engines to extract summaries from the content).
The meta description is a type of HTML metadata that influences SEO. It provides a summary of the page, and often, search engines will use it as the search result snippet for that page, if they think it gives users a more accurate description than would be possible generating one purely from the on-page content.
The HTML files used by browsers to render our documentation are generated from non-HTML sources, i.e. rST. This means that we never directly edit the HTML source files, including the meta description and any other HTML metadata. Therefore, we cannot set the meta description directly in the raw HTML. Our Sphinx starter pack automatically generates the meta description for each HTML page from the first 200 visible characters of its main text, excluding the top-level heading, using the sphinxext-opengraph extension.
But we can manually set custom meta description to override the auto-generated one, using the meta directive at the top of the file, with the description option.
Type of change
Delete options that are not relevant.
How has this been tested?
I've tested the changes locally.
Note
All functional changes should accompany corresponding tests (unit tests, functional tests, etc.).
Please describe the addition/modification of tests done to verify this change. Also list any
relevant details for your test configuration.
Contributor checklist
Please check that you have: