Skip to content

Chore: Fix broken links 20250929 #343

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Sep 29, 2025
Merged

Chore: Fix broken links 20250929 #343

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1c67531
Chore: Fix broken links after reorg on docs.docker.com
amotl Sep 29, 2025
19583b1
Chore: Make link checker ignore phase-out of CrateDB 3.3 docs
amotl Sep 29, 2025
39b3837
Chore: Don't make ADO.NET auto-link to ado.net
amotl Sep 29, 2025
9c68fa3
Chore: Improve link to O'REILLY
amotl Sep 29, 2025
5e9de15
Chore: Make link checker ignore docs.docker.com
amotl Sep 29, 2025
19f72a2
Chore: Use `button-ref` for linking to `first-steps`
amotl Sep 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,10 @@
r"https://openai.com/index/gpt-4/.*",
# 403 Client Error: Forbidden for url
r"https://www.npmjs.com/",
# 2025-09-29: Phased out CrateDB 3.3 docs
r"https://cratedb.com/docs/crate/reference/en/3.3/",
# 403 Client Error: Forbidden for url
r"https://docs.docker.com/",
Comment on lines +82 to +83
Copy link

@coderabbitai coderabbitai bot Sep 29, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Scope the Docker docs ignore more narrowly. Ignoring the entire docs.docker.com domain disables linkcheck coverage for working pages like the CLI reference, so future regressions there would slip through. The 403s we’ve observed are confined to specific sections (for example engine/containers/... and compose/...). Let’s keep the pattern focused on those hot spots and keep the rest of the domain under linkcheck.

-    # 403 Client Error: Forbidden for url
-    r"https://docs.docker.com/",
+    # 403 Client Error: Forbidden for url (engine container docs & compose manuals)
+    r"https://docs.docker.com/engine/containers/.*",
+    r"https://docs.docker.com/compose/.*",

Based on learnings

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# 403 Client Error: Forbidden for url
r"https://docs.docker.com/",
# 403 Client Error: Forbidden for url (engine container docs & compose manuals)
r"https://docs.docker.com/engine/containers/.*",
r"https://docs.docker.com/compose/.*",
🤖 Prompt for AI Agents 
In docs/conf.py around lines 82 to 83, the current ignore pattern excludes the
entire docs.docker.com domain; narrow it to only the problematic paths (e.g.
engine/containers and compose) so other pages remain linkchecked. Replace the
broad entry with one or more specific regexes that match those sections (for
example patterns that include docs.docker.com/.*/engine/containers/ and
docs.docker.com/.*/compose/) or otherwise add path-specific entries to the
linkcheck_ignore list to target only the known 403 hotspots.

]

linkcheck_anchors_ignore_for_url += [
Expand Down
2 changes: 1 addition & 1 deletion docs/connect/drivers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ For connecting to CrateDB from any environment that supports it.
[Npgsql](https://www.npgsql.org/)
```
```{sd-item}
An open source ADO.NET Data Provider for PostgreSQL, for program written in C#,
An open source ADO\.NET Data Provider for PostgreSQL, for program written in C#,
Visual Basic, and F#.
```
```{sd-item}
Expand Down
2 changes: 1 addition & 1 deletion docs/home/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ unique features.
Start with a fully managed FREE FOREVER CrateDB instance to quickly explore
features through guided tutorials or on your own with custom data.
+++
```{button-link} first-steps
```{button-ref} first-steps
:color: primary
:expand:
**Get started with CrateDB Cloud**
Expand Down
10 changes: 5 additions & 5 deletions docs/install/container/docker.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ Taking it further
:ref:`CrateDB settings <crate-reference:config>` are set
using the ``-C`` flag, as shown in the examples above.

Check out the `Docker docs <https://docs.docker.com/engine/reference/run/>`_
Check out the `Docker docs <https://docs.docker.com/reference/cli/docker/>`_
for more Docker-specific features that CrateDB can leverage.


Expand Down Expand Up @@ -494,14 +494,14 @@ example::
.. _compose file version: https://docs.docker.com/compose/compose-file/compose-versioning/
.. _containerization: https://www.docker.com/resources/what-container
.. _CrateDB Docker image: https://hub.docker.com/_/crate/
.. _default bridge network: https://docs.docker.com/network/drivers/bridge/#use-the-default-bridge-network
.. _default bridge network: https://docs.docker.com/engine/network/drivers/bridge/#configure-the-default-bridge-network
.. _Docker Stack YAML file: https://docs.docker.com/reference/compose-file/legacy-versions/
.. _Docker Swarm: https://docs.docker.com/engine/swarm/
.. _Docker volume: https://docs.docker.com/engine/tutorials/dockervolumes/
.. _Docker: https://www.docker.com/
.. _healthcheck: https://docs.docker.com/engine/reference/builder/#healthcheck
.. _healthcheck: https://docs.docker.com/engine/containers/run/#healthchecks
.. _horizontally scalable: https://en.wikipedia.org/wiki/Scalability#Horizontal_(scale_out)_and_vertical_scaling_(scale_up)
.. _set the maximum memory: https://docs.docker.com/config/containers/resource_constraints/#memory
.. _set the maximum number of CPUs: https://docs.docker.com/config/containers/resource_constraints/#cpu
.. _set the maximum memory: https://docs.docker.com/engine/containers/resource_constraints/#memory
.. _set the maximum number of CPUs: https://docs.docker.com/engine/containers/resource_constraints/#cpu
.. _shared-nothing architecture: https://en.wikipedia.org/wiki/Shared-nothing_architecture
.. _user-defined network: https://docs.docker.com/network/bridge/
2 changes: 1 addition & 1 deletion docs/topic/timeseries/generate/node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ zooming out.
[detailed guide]: https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Asynchronous/Promises
[ground point]: https://en.wikipedia.org/wiki/Ground_track
[input values]: https://node-postgres.com/features/queries#Parameterized%20query
[interactive repl mode]: https://web.archive.org/web/20240910181004/https://www.oreilly.com/library/view/learning-node-2nd/9781491943113/ch04.html
[interactive repl mode]: https://www.oreilly.com/library/view/learning-node-2nd/9781491943113/ch04.html
[international space station]: https://www.nasa.gov/mission_pages/station/main/index.html
[node-postgres]: https://www.npmjs.com/package/pg
[node.js]: https://nodejs.org/en/
Expand Down