Skip to content
New issue

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

Linking to internal sections is broken #88

Open
ogarod opened this issue Mar 12, 2018 · 0 comments
Open

Linking to internal sections is broken #88

ogarod opened this issue Mar 12, 2018 · 0 comments

Comments

@ogarod
Copy link
Contributor

ogarod commented Mar 12, 2018

According to https://mkdocs.readthedocs.io/en/0.9/user-guide/writing-your-docs/ the syntax for linking to sections in internal pages is supposed to be something like:

project license for further details.

However, links like these do not work on readthedocs.io. E.g, on this page

http://grr-doc.readthedocs.io/en/v3.2.2/deploying-grr-clients/overview.html

the html anchor tag 'Linux instructions' has the href attribute

http://grr-doc.readthedocs.io/en/v3.2.2/deploying-grr-clients/on-linux.md#uninstalling-grr

which goes to a page that doesn't exist on the documentation site ("SORRY This page does not exist yet.").

Note that the '.md' in the hyperlink url does not get replaced with '.html'.

Here are all the places where we try to link to sections in internal pages:

$ grep * -R -e 'md#'
deploying-grr-clients/overview.md:A quick manual on how to remove the GRR client completely from a machine is included in the platform-specific docs: [Windows instructions](on-windows.md#uninstalling-grr), [OSX instructions](on-mac-os-x.md#uninstalling-grr), [Linux instructions](on-linux.md#uninstalling-grr)
faq.md:time](admin.md#building-clients-with-custom-labels-multi-organization-deployments),
faq.md:system](user_manual.md#artifacts).
faq.md:AdminUI](admin.md#authentication-to-the-admin-ui)
maintaining-and-tuning/scaling.md:The [GRR server components](implementation.md#grr-component-overview)
release-notes.md:versions](admin.md#client-and-server-version-compatibility-and-numbering).
release-notes.md:    [here](faq.md#what-operating-system-versions-does-the-client-support)
release-notes.md:versions](admin.md#client-and-server-version-compatibility-and-numbering).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant