docs: add meta descriptions #1362
Draft
+176
−13
Conversation
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
Contributor
Author
|
Docs won't build until #1362 is merged (update: done). |
There is only one tutorial so it doesn't the side nav doesn't need to nest that entry. This also means that the tutorial index page (not needed) won't be prioritised in search.
Meta descriptions make it easier for users to determine if a page in a page in a search engine result is what they want. It (usually) determines the description shown in the search result.
edibotopic
force-pushed
the
docs-add-meta-descriptions
branch
from
d01373d to
a984744
Compare
Contributor
Author
|
@denisonbarbosa --- I think that these metadata sections don't play well with the automated docs tests 🥲 . However, we are required to implement them, so I'm not sure how to approach this. A short-term fix is to remove the metadata from the docs pages that are triggering the failures and revisit the tests at a later date. Another option is to ensure that the docs tests skip YAML sections when parsing markdown files. To be honest, I'm not sure how useful these doc tests are, but I'm open to being convinced. |
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.
Adds meta descriptions to all pages (except autogenerated ones).
These meta descriptions are (usually) shown to users who find ADSys docs in search results.
So it helps users find the documentation that they need.
Related to this change, as we have only one tutorial there is no need to have a nested entry for tutorials in the side navigation.
This also had the effect of producing two search results for Tutorial (the index and the page itself). An index with one entry is not necessary.
So now, a user can just click on Tutorial and read the tutorial without needing to click again.
UDENG-8756