pulp / pulpcore

Pulp 3 pulpcore package https://pypi.org/project/pulpcore/
GNU General Public License v2.0
252 stars 107 forks source link

Docs: Fix rst leftover errors #5496

Open pedro-psb opened 2 weeks ago

pedro-psb commented 2 weeks ago

After migrating the docs to markdown, there is still some fair amount of documents with rst leftover errors.

Some common pattern observed:

AndersBennedsgaard commented 6 days ago

I don't know if it is relevant here, since I'm a newcomer for Pulp, but there are also a lot of broken links, and links to incorrect places. A couple of examples:

You hit many other examples if you just browse through the website. It might make sense to have some automation for detecting broken links. We use tcort/markdown-link-check successfully as validation in a CI pipeline


Another note: the documentation needs some sort of sorting/weighting between pages. It doesn't make sense that the Pulp CLI how-to guides go "Configure (advanced) -> Configure (basic) -> Install":

image

lubosmj commented 1 day ago

This site is also completely broken: https://pulpproject.org/pulpcore/docs/dev/guides/plugin-walkthrough/.