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

New docs: make all URLs in MDX (markdown or JSX) root relative #6815

Closed
lunelson opened this issue Sep 28, 2020 · 2 comments
Closed

New docs: make all URLs in MDX (markdown or JSX) root relative #6815

lunelson opened this issue Sep 28, 2020 · 2 comments
Labels
type:docs 📖 Improvements to the documenation. Adding missing pieces or improving existing ones.

Comments

@lunelson
Copy link
Contributor

Currently, the links to "prototype an assistant" from the Installation page at https://rasa.com/docs/rasa/installation are written relatively, which means that
if you are on the trailing slash version of the URL (https://rasa.com/docs/rasa/installation/, which Netlify treats equally to the non-trailing-slash URL), and you follow a link to prototype-an-assistant it is broken, because the browser looks for a sibling of installation/index.html rather than a sibling of installation.html.

Unfortunately we have to work with trailing slashes, due to limited choices in redirection patterns with Netlify, so we need to note in our style guide that links must be root-relative, i.e. /docs/rasa/prototype-an-assistant at all times.

Alternative: can the CI be configured to catch these?

@lunelson lunelson added the type:docs 📖 Improvements to the documenation. Adding missing pieces or improving existing ones. label Sep 28, 2020
@erohmensing
Copy link
Contributor

@m-vdb i believe this was automated with the useBaseUrl ci check, right?

@m-vdb
Copy link
Collaborator

m-vdb commented Oct 15, 2020

yes this is fixed, we can close this 👍

@m-vdb m-vdb closed this as completed Oct 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:docs 📖 Improvements to the documenation. Adding missing pieces or improving existing ones.
Projects
None yet
Development

No branches or pull requests

3 participants