Open pedro-psb opened 2 weeks 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:
pulp_python
in https://pulpproject.org/pulp_python/docs/user/guides/00-overview/restapi.html, which doesn't exist.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":
This site is also completely broken: https://pulpproject.org/pulpcore/docs/dev/guides/plugin-walkthrough/.
After migrating the docs to markdown, there is still some fair amount of documents with rst leftover errors.
Some common pattern observed:
`some-word`
) were internal links before. That's a bit hard to distinguish now and is the least automatable IHO.:something:
, which I think are different kinds of links{something}
. Mostly{class}
, which reference generated code API doc: