Version links broken on 'latest'

boarchuz
Posts: 320
Joined: Tue Aug 21, 2018 5:28 am

Version links broken on 'latest'

Postby boarchuz » Thu Feb 06, 2020 12:28 am

Using the 'Read The Docs' popup menu to select a different version of the IDF docs on any page seems to fall back to the root https://www.espressif.com/en/support/download/documents page.

Take the 'latest' HTTP server page, for example: https://docs.espressif.com/projects/esp ... erver.html
The link to 'release-v3.3' is "https://docs.espressif.com/en/release-v3.3/", which is not only invalid (a valid root url would be https://docs.espressif.com/projects/esp ... ease-v3.3/) but doesn't even try to link to the 'HTTP server' page as expected.

Actually this is a little more complex than I first realised. Perhaps it only affects 'latest'...
Opening https://docs.espressif.com/projects/esp ... erver.html will cause the bug, however opening https://docs.espressif.com/projects/esp ... erver.html is fine (and I can even switch to 'latest' and then to any other version without problems - does the popup menu not reload?).

Oh yeah I see now in the Chromium log, for 'latest' only:

Code: Select all

Error loading Read the Docs footer
error @ readthedocs-doc-embed.js:1
Ironically, the "Submit documentation feedback to us." link on the page it redirects to (https://www.espressif.com/en/support/download/documents) is dead.

ESP_Angus
Posts: 2227
Joined: Sun May 08, 2016 4:11 am

Re: Version links broken on 'latest'

Postby ESP_Angus » Thu Feb 06, 2020 2:18 am

boarchuz wrote:
Thu Feb 06, 2020 12:28 am
Using the 'Read The Docs' popup menu to select a different version of the IDF docs on any page seems to fall back to the root https://www.espressif.com/en/support/download/documents page.
Thanks for letting us know. Because the RTD servers are slow to access from China (and their CDN doesn't have China coverage), we maintain a transparent caching reverse proxy for the ESP-IDF documentation.

In this case it looks like an RTD update changed the API URL, so the proxy stopped working.

This should be fixed now (may require a ignore-caches-reload with Shift-F5 or similar). Please let us know if you see any more problems.
Ironically, the "Submit documentation feedback to us." link on the page it redirects to (https://www.espressif.com/en/support/download/documents) is dead.
Thanks for letting us know about this as well, will get it fixed ASAP.

boarchuz
Posts: 320
Joined: Tue Aug 21, 2018 5:28 am

Re: Version links broken on 'latest'

Postby boarchuz » Thu May 07, 2020 3:28 pm

ESP_Angus wrote:
Thu Feb 06, 2020 2:18 am
Please let us know if you see any more problems.
"View page source" links are broken throughout latest
eg. https://docs.espressif.com/projects/esp ... index.html currently links to https://docs.espressif.com/projects/esp ... ig.rst.txt instead of the expected github.com/...

Also the Sphinx "theme" link in the footer is broken.

boarchuz
Posts: 320
Joined: Tue Aug 21, 2018 5:28 am

Re: Version links broken on 'latest'

Postby boarchuz » Thu May 07, 2020 3:43 pm

Doc for esp_https_ota_get_image_len_read (https://docs.espressif.com/projects/esp ... a_handle_t) isn't generated.

User avatar
ESP_krzychb
Posts: 308
Joined: Sat Oct 01, 2016 9:05 am
Contact:

Re: Version links broken on 'latest'

Postby ESP_krzychb » Thu May 07, 2020 7:27 pm

Hi boarchuz,

A fix to broken link to "View page source" should be soon pushed to GitHub.
I will follow up on the the other issues.

Thank you for pointing all these issues!

boarchuz
Posts: 320
Joined: Tue Aug 21, 2018 5:28 am

Re: Version links broken on 'latest'

Postby boarchuz » Mon Jun 15, 2020 1:49 pm

TRM link in docs is broken: IDF_TARGET_TRM_URL is not replaced with the actual url.

In the Introduction here: https://docs.espressif.com/projects/esp ... h_pad.html

chegewara
Posts: 1258
Joined: Wed Jun 14, 2017 9:00 pm

Re: Version links broken on 'latest'

Postby chegewara » Mon Jun 15, 2020 2:05 pm

Sorry, i dont want to hijack this topic, but there is more broken links on github:
- 1st link in this readme:
https://github.com/espressif/esp-idf/bl ... /README.md
- 1st link here:
https://github.com/espressif/esp-idf/bl ... e-analysis

I cant find one readme where is about 10 links to https://docs.espressif.com/projects/esp ... index.html API and all broken.

User avatar
ESP_krzychb
Posts: 308
Joined: Sat Oct 01, 2016 9:05 am
Contact:

Re: Version links broken on 'latest'

Postby ESP_krzychb » Mon Jun 15, 2020 4:57 pm

Hi boarchuz,

Thank you for being patient with us. I will fix this one as well.

Hi chegewara,

We do not have automatic testing of links of readme files in https://github.com/espressif/esp-idf/tr ... r/examples but will get to this one as well. Thank you for hijacking this topic. I am always happy to hear from you :)

ESP_Alvin
Posts: 145
Joined: Thu May 17, 2018 2:26 am

Re: Version links broken on 'latest'

Postby ESP_Alvin » Mon Jul 13, 2020 3:49 am

Hi boarchuz,

Thanks for reporting and sorry for late updates, the fix is available at https://github.com/espressif/esp-idf/co ... c775d92c5d. Thanks.

Alvin

chegewara
Posts: 1258
Joined: Wed Jun 14, 2017 9:00 pm

Re: Version links broken on 'latest'

Postby chegewara » Thu Jul 16, 2020 1:55 pm


Who is online

Users browsing this forum: No registered users and 3 guests