-
Type:
Task
-
Resolution: Done
-
Priority:
Trivial - P5
-
None
-
Affects Version/s: None
-
Component/s: django
-
None
-
None
-
Python Drivers
-
Not Needed
-
None
-
None
-
None
-
None
-
None
-
None
Context
Running make -C docs linkcheck locally reveals four broken links in the documentation, and there is currently no CI job to catch regressions.
Broken links to fix:
1. intro/index.rst line 16 — https://www.djangoproject.org/ fails DNS resolution; should be https://www.djangoproject.com/
2. howto/queryable-encryption.rst line 33 — anchor #std-label-qe-csfle-shared-library-download no longer exists on the MongoDB docs page
3. topics/embedded-models.rst line 4 — anchor #embedded-data no longer exists on the MongoDB data modeling page
4. ref/models/indexes.rst line 102 — anchor #std-label-avs-similarity-functions no longer exists on the Vector Search docs page
Definition of done
- All four broken links are resolved (done)
- A CI job runs make -C docs linkcheck on every pull request and fails on broken links
Pitfalls
May need to use skip and/or header linkcheck config from pymongo's conf.py. Prefer to use stable dochub links where available.