patternfly / patternfly/patternfly-org
Create documentation for markdown metadata
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 74
- Forks
- 147
- Avg merge
- 4d 11h
- Merged PRs (30d)
- 2
Description
Is this a new page or a change to an existing one?
New page/file
Describe the enhancement
We currently don't have any documentation for the markdown metadata, i.e. what the options are, what each one does, which ones are required, etc.
This documentation is needed if we want people outside of the team to be able to use the docs framework.
Jira Issue: PF-384
Contributor guide
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 locating the docs framework's existing markdown metadata definitions and examples. Document the available options, what each does, and which are required in a new markdown metadata page, then verify that the page explains how people outside the team can use the framework.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100