Add method for including version changes

Open
#65 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
markdown
Domain
documentation

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.

Description

enhancement

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.

Dominant language
HTML
Stars
2
Forks
17
Avg merge
7d 18h
Merged PRs (30d)
3

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pulp/pulp-docs

All issues in pulp/pulp-docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.