Skip to content
This repository has been archived by the owner on Jan 29, 2024. It is now read-only.

Use Sphinx :doc: roles for links to docs.aiven.io documents #1548

Open
TibsAtWork opened this issue Nov 10, 2022 · 0 comments
Open

Use Sphinx :doc: roles for links to docs.aiven.io documents #1548

TibsAtWork opened this issue Nov 10, 2022 · 0 comments
Labels
maintenance maintenance tasks for the documentation website Related to the website or other implementation

Comments

@TibsAtWork
Copy link
Contributor

TibsAtWork commented Nov 10, 2022

We used to have to be more cautious about using :doc: because Vale would spell check the document names.

Now that's not an issue, we could look for all the https://docs.aiven.io links and consider converting them to :doc: links.

Why is this worth doing? Mainly because it makes it clearer that the links are into our own documentation. It also reduces the length of the link, making it easier to read the source text.

@TibsAtWork TibsAtWork added website Related to the website or other implementation maintenance maintenance tasks for the documentation labels Nov 10, 2022
@TibsAtWork TibsAtWork changed the title Use Spinnx :doc: roles for links to docs.aiven.io documents Use Sphinx :doc: roles for links to docs.aiven.io documents Nov 10, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
maintenance maintenance tasks for the documentation website Related to the website or other implementation
Projects
None yet
Development

No branches or pull requests

1 participant