coreos / coreos/fedora-coreos-docs
FCOS docs discoverability: add metadata to pages
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 68
- Forks
- 156
- Avg merge
- 14d 2h
- Merged PRs (30d)
- 1
Description
As discussed during the meeting of 2021-03-31, lack of metadata and search functionality has hindered documentation usage, and complicated design and placement decisions.
Moving forward, it would be helpful to incorporate search into the site (e.g. Google) and incorporate metadata into each page that accurately reflects the topics therein.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the 2021-03-31 Fedora CoreOS meeting notes and the linked Antora title-and-metadata guidance. Identify where this documentation site defines its pages and search behavior, then determine the metadata needed for each page and how search should be incorporated. Done means pages accurately reflect their topics and users can find documentation through the chosen search functionality.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100