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

Fix Broken Links #871

Merged
merged 12 commits into from
Oct 14, 2024
Merged

Fix Broken Links #871

merged 12 commits into from
Oct 14, 2024

Conversation

geographika
Copy link
Contributor

@geographika geographika commented Sep 26, 2024

CI builds are currently failing due to broken links in the docs.

This pull request:

  • updates any permanent URL redirects to the new URL
  • fixes some of the broken links
  • ignores checks to StackOverlow - the rate limiting causes these to fail, and makes the CI run for several minutes retrying

Questions:

  • Should doc/quickstart/vmware_quickstart.rst be removed? It is not in the HTML output and is written for OSGeoLive 5.5.

@geographika geographika force-pushed the link-fixes branch 5 times, most recently from 9c9f9ee to 9e95795 Compare September 26, 2024 09:45
@geographika
Copy link
Contributor Author

geographika commented Sep 26, 2024

The linkchecking is quite flaky. I think all URLs across all languages are checked on every pull request by https://github.com/OSGeo/OSGeoLive-doc/blob/master/.github/workflows/linkcheck.yml as the https://github.com/OSGeo/OSGeoLive-doc/blob/master/.github/workflows/locale-update.yml action updates the language files automatically.

Maybe the linkcheck action should only be triggered by specific tags in a commit? Otherwise most doc pull requests will fail for unrelated reasons. https://demo.pycsw.org/ is now failing having passed the tests all morning, and seems fine in a browser.

@geographika geographika marked this pull request as ready for review September 26, 2024 09:56
@geographika geographika force-pushed the link-fixes branch 4 times, most recently from 26b004d to 5f93613 Compare September 26, 2024 12:05
Ignore https://demo.pycsw.org

Increase the number of retries

URL fixes in language translations

Ignore freenode checks and update GDAL tutorial links

Ignore StackOverflow link checks as they are rate limited

Update permanent redirects
@geographika
Copy link
Contributor Author

With the various fixes and increased retries, the checks currently seem stable (green ticks across all CI checks for 3 pushes in a row). Ready to merge from my side.

doc/conf.py Outdated Show resolved Hide resolved
doc/conf.py Outdated Show resolved Hide resolved
doc/conf.py Outdated Show resolved Hide resolved
@@ -29,11 +29,11 @@ Software
----------------
Download the VM version of OSGeoLive. You will need the 7-zip compression program to unzip this file. And of course the VMWare Player software for running the virtual machine. Note that VMWare Player, while offered as a cost-free download, is not open source. You must register on the VMWare website, and agree to their licence in order to use the software.:

`The OSGeo virtual machine <http://download.osgeo.org/livedvd/release/5.5/osgeolive-vm-5.5.7z>`_
`The OSGeo virtual machine <https://download.osgeo.org/livedvd/releases/5.5/>`_
Copy link
Member

@neteler neteler Sep 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

V5.5 is very old, perhaps point to the parent directory (and update the file header above?).

Or, make it clear (also below) that "5.5" is just an example?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@neteler vmware_quickstart.rst isn't linked to from anywhere and isn't available at https://live.osgeo.org/en/quickstart/vmware_quickstart.html so I'm thinking this whole file is outdated and could be removed?

geographika and others added 2 commits September 30, 2024 13:20
Co-authored-by: Markus Neteler <markus@neteler.org>
Co-authored-by: Markus Neteler <markus@neteler.org>
geographika and others added 5 commits September 30, 2024 13:22
Co-authored-by: Markus Neteler <markus@neteler.org>
Co-authored-by: Markus Neteler <markus@neteler.org>
Co-authored-by: Markus Neteler <markus@neteler.org>
Co-authored-by: Markus Neteler <markus@neteler.org>
@neteler
Copy link
Member

neteler commented Sep 30, 2024

(I have fixed the ZOO URLs in 0364236, now the CI passes.)

@geographika
Copy link
Contributor Author

Thanks for the review @neteler. I've addressed all the comments, apart from the VMWare link. The VMWare page is very outdated (referring to OSGeoLive 5.5), so should either be removed or updated and tested in a separate pull request.

@cvvergara cvvergara merged commit 8432032 into OSGeo:master Oct 14, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants