canonical / sphinx-docs-starter-pack

A documentation starter-pack
https://canonical-starter-pack.readthedocs-hosted.com/
Other
15 stars 40 forks source link

Remove Library links from the template #124

Closed rkratky closed 1 year ago

rkratky commented 1 year ago

The Canonical Library is not accessible to the public, so the links to it that are included in reuse/links.txt would not resolve for regular consumers of the docs.

syncronize-issues-to-jira[bot] commented 1 year ago

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/DOCPR-172.

This message was autogenerated

ru-fu commented 1 year ago

Yes, that's an issue with the documents being in the library. But we do want Canonical users to check those documents, so I wouldn't want to remove them entirely. Maybe have them in the readme instead of the index page, and make it clear that they aren't publicly accessible?

rkratky commented 1 year ago

On second thought, this is unnecessary because the links are only surfaced in the Starter Pack docs -- not in the product dopcs that the Starter Pacgk is used for. Ergo, no need to fret over it.