Move glossary definitions to yaml format #6162
Merged
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.
Converts the site-wide glossary to be hosted in a YAML file. Initially, only a few of the fields are used:
term
- for the header entry and default fragmentid
- (optional) to override the default fragmentlong_description
- (but will fallback toshort_description
if missing)related_links
- For linking to other docsA few other fields have been added for experimentation but are not yet used or surfaced.
short_description
- A shorter description to be shown on hovercategory
- A primary category for the termlabels
- Labels/topics that can be used for filtrationalternate
- Alternate and related terms that should lead to this entry. Could be because they are synonyms or that term doesn't yet have a specific entry of its own, but is still relevant enough.Also new to the page:
The current style of this information will likely be completely replaced as more information is surfaced and filtering is added.
This work is roughly based on the design proposed in https://flutter.dev/go/glossary-expansion and the Fuchsia glossary.
Resolves #6143
Staged: https://dart-dev--pr6162-feat-6143-bema0uix.web.app/resources/glossary