zephyrproject-rtos / zephyr

Primary Git Repository for the Zephyr Project. Zephyr is a new generation, scalable, optimized, secure RTOS for multiple hardware architectures.
https://docs.zephyrproject.org
Apache License 2.0
10.88k stars 6.63k forks source link

Invalid documentation link in README.rst #9932

Closed kestewart closed 6 years ago

kestewart commented 6 years ago

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 commented 6 years ago

@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 commented 6 years ago

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

dbkinder commented 6 years ago

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 commented 6 years ago

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 commented 6 years ago

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.