pulp / pulp/pulp-docs

Create a page with reference to last legacy docs commits

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

Nobody has claimed this yet.

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

Description

Sometimes we wanna know where something from legacy sphinx docs went.
Since they are not in main anymore, it can be tricky to find the latest available source for them.

I would like to have a reference page that list the latest commits when they existed, before being completely replaced by the new markdown docs.

The list (WIP)

https://github.com/pulp/pulpcore/commit/c0c622325a8aea65d3a88501ef410ba38b3c38e2

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.

Research direction

Start by reviewing the existing documentation structure and the linked pulpcore commit c0c622325a8aea65d3a88501ef410ba38b3c38e. Create a reference page listing the latest commits for legacy Sphinx documentation that was replaced by Markdown docs; done means readers can use the page to locate those historical sources.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.