pulp/pulp-cli

Weird documentation URLs

Closed this issue · 2 comments

quba42 commented

Not sure how important this is, but I noticed the pulp-cli documentation uses some rather odd URLs relative to every other component documentation I have checked.

For example, every plugin I checked as well as core has:

https://docs.pulpproject.org/pulpcore/changes.html

But for pulp_cli it's:

https://docs.pulpproject.org/pulp_cli/CHANGES/

Similar for other documentation sections. Is there a reason for this? Are we building the docs for pulp-cli differently somehow?

Expectation:

Keeping documentation URLs consistent across different plugins for easy navigation.

mdellweg commented

The docs in the cli are written in markdown using mkdocs instead of ReST and sphinx.
I think this brings that change along.

ggainey commented

We don't have the bandwidth to spend on figuring out what's going on here and make everything "nice" -so I'm going to close this. HOWEVER - if it really bugs people, feel free to submit a PR to address and reopen :)