Add method for including version changes
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 2
- Forks
- 17
- Avg merge
- 7d 18h
- Merged PRs (30d)
- 3
Description
We should have some standard on how to inform "Added in x.y.z", "Modified in x.y.z" and "Removed in x.y.z".
Ideally, people wont need to type the exact "added in", etc, which could lead to inconsistent styles of working and looking.
Using custom admonitions ^1 looks a good balance between new and familiar syntax.
Also, I found a plugin ^2 that's look having a look that does something like that.
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 reviewing the linked MkDocs Material custom-admonitions reference and the markdown-version-annotations plugin. Determine which approach fits Pulp Docs and define the expected syntax and rendering for added, modified, and removed version annotations. Done means the project has an agreed, consistent way to express and display these changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100