We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
We noticed in https://github.com/scylladb/scylla/pull/11092/files that some documentation projects such as scylla-docs were using the external link directive for linking internal docs.
For example:
* `Scylla Housekeeping and how to disable it <disable-housekeeping>`_
Instead of:
* :doc:`Scylla Housekeeping and how to disable it <disable-housekeeping>`
While the link might work in the local environment, it might not work in production since the URL of the link changes due to multiversion.
Raise a new warning if there are internal docs referenced using the external links directive.
The text was updated successfully, but these errors were encountered:
No branches or pull requests
Motivation
We noticed in https://github.com/scylladb/scylla/pull/11092/files that some documentation projects such as scylla-docs were using the external link directive for linking internal docs.
For example:
Instead of:
While the link might work in the local environment, it might not work in production since the URL of the link changes due to multiversion.
Proposal
Raise a new warning if there are internal docs referenced using the external links directive.
The text was updated successfully, but these errors were encountered: