Skip to content

Invalid documentation link in README.rst #9932

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

Closed
kestewart opened this issue Sep 12, 2018 · 5 comments
Closed

Invalid documentation link in README.rst #9932

kestewart opened this issue Sep 12, 2018 · 5 comments
Assignees
Labels
area: Documentation bug The issue is a bug, or the PR is fixing a bug priority: medium Medium impact/importance bug
Milestone

Comments

@kestewart
Copy link
Member

https://github.com/zephyrproject-rtos/zephyr/blob/master/README.rst has invalid link to new boards

The Zephyr kernel supports multiple architectures, including ARM Cortex-M, Intel x86, ARC, Nios II, Tensilica Xtensa, and RISC-V, and a large number of supported boards.

Supported boards link redirects to https://docs.zephyrproject.org/latest/404.html

@dbkinder
Copy link
Contributor

@nashif You had redirects in for references such as https://docs.zephyrproject.org/boards/boards.html to be redirected to https://docs.zephyrproject.org/latest/boards/boards.html. Are these redirects gone now?

@nashif nashif added bug The issue is a bug, or the PR is fixing a bug priority: medium Medium impact/importance bug labels Sep 12, 2018
@nashif
Copy link
Member

nashif commented Sep 12, 2018

removed the redirects after founding issues, fixed links now and will revisit the redirects later.

nashif added a commit to nashif/zephyr that referenced this issue Sep 12, 2018
Fixed URL to documentation, now latest docs are under /latest/..
Fixes zephyrproject-rtos#9932

Signed-off-by: Anas Nashif <[email protected]>
@dbkinder
Copy link
Contributor

To clarify, the "problem" is that we moved the latest documentation down into a /latest folder (a sibling folder to the tagged release documentation such as /1.13.0 and 1.12.0). Now, any deep link such as https://docs.zephyrproject.org/boards/boards.html that does not include the doc version folder name (or /latest) will return a 404 error. We can fix links within the Zephyr documentation, but not incoming links from other sites. Over time, folks will update their links, but until then, we're likely to get a barrage of 404 errors from google searches and links from external sites.

For example, doing a google search for "zephyr usb support" returns a link to http://docs.zephyrproject.org/subsystems/usb/usb.html which will get a 404 error.

@nashif
Copy link
Member

nashif commented Sep 12, 2018

not really concerned about google, it will update its database soon enough.

btw, clicking links from google that lead to 404 have this message:

"Sorry, the page you requested: https://www.google.com/ was not found on this site."

:)

Need to fix this.

@dbkinder
Copy link
Contributor

We're not getting usable information when redirected to the 404 page to report the URL that was originally being referenced (I've tried a couple of obvious alternatives), so I'll just remove the JS code that's trying to figure this out.

@dbkinder dbkinder changed the title Invalid documationtion link in README.rst Invalid documentation link in README.rst Sep 12, 2018
nashif added a commit that referenced this issue Sep 12, 2018
Fixed URL to documentation, now latest docs are under /latest/..
Fixes #9932

Signed-off-by: Anas Nashif <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Documentation bug The issue is a bug, or the PR is fixing a bug priority: medium Medium impact/importance bug
Projects
None yet
Development

No branches or pull requests

3 participants