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

Broken links in documentation #5574

Closed
tkazec opened this issue Oct 26, 2018 · 3 comments
Closed

Broken links in documentation #5574

tkazec opened this issue Oct 26, 2018 · 3 comments

Comments

@tkazec
Copy link

tkazec commented Oct 26, 2018

https://facebook.github.io/create-react-app/docs/advanced-configuration

You can adjust various development and production settings by setting environment variables in your shell or with .env.

.env links to https://facebook.github.io/docs/adding-development-environment-variables-in-env, which does not exist. I could not find any equivalent URL through Google.


https://facebook.github.io/create-react-app/docs/using-https-in-development

One particular case where this could be useful is when using the "proxy" feature to proxy requests to an API server when that API server is itself serving HTTPS.

the "proxy" feature links to https://facebook.github.io/docs/proxying-api-requests-in-development, which does not exist. I could not find any equivalent URL through Google.

@BuckyMaler
Copy link

It appears many, if not all, links to document files are broken. Absolute paths are used at this time, however Docusaurus recommends document linking differently.

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

For example, [.env](/docs/adding-development-environment-variables-in-env) in advanced-configuration.md should be [.env](adding-custom-environment-variables.md). As you can see I also included the updated filename. As noted above, the document's id can also be used, but since that's optional it may be a good convention to use the filename always.

@tkazec if you don't have time to submit a PR, I'd be happy to. I imagine this PR should update all broken document links.

@tkazec
Copy link
Author

tkazec commented Oct 27, 2018

@BuckyMaler Wow thanks for the detailed explanation! Unfortunately I am in a huge time crunch at the moment (create-react-app is helping though!) and won't be able to fix this myself.

@BuckyMaler
Copy link

#5552 fixes this.

@tkazec tkazec closed this as completed Nov 5, 2018
@lock lock bot locked and limited conversation to collaborators Jan 9, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants