Comments (1)
Near as I can tell, rstcheck doesn't validate for a well-formed URI inside the hyperlink. The docutils spec for RST is here - https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#embedded-uris-and-aliases
The links that are quietly broken (not found by CI), are as follows:
Control Node Requirements <:ref:control-node-requirements>
_
So it has a title (Control Node Requirements) and a URI . So if nothing acutally checks the blablabla, the test passes.
That syntax is used for external links. The internal link syntax is :ref:Control Node Requirments <blablabla>
and if that were incorrect, rstcheck would flag it.
So a correct external link would be Control Node Requirements <http://docs.ansible.com/blablbla>
_
aka it was a clever way of combining the two to seem like it would work, but didn't, and didn't fail tests either
from community-team.
Related Issues (20)
- [Task]: Update Controller docs on docs.ansible.com to remove stale content
- Sprint planning HOT 1
- Task: Define redirect strategy for Ansible package docs on RTD
- Task: Define the strategy for migration to RTD for community and project awareness and readiness
- [Task] DevConf 2024: Prep Ansible for fun and profit meetup
- [Task]: DevConf 2024: Introduction to creating automation with Ansible Development Tools
- [Task] Evaluate and identify ways to help DevTools community adoption
- Task: Make it possible to switch easily between projects in the Ansible RTD namespace
- Task: Update the theme navigation to remove the version switcher
- Task: Move the "docs.ansible.com" subdomain to Read The Docs
- Task: Add and update forum post on the migration to Read The Docs
- As a member of the Ansible community, core team, or other project team, I need to understand the strategy for the migration so that I am aware of the changes and can help prevent bad outcomes
- As a member of the community engineering team, I need to ensure that docs hosted on Read The Docs is easy to discover, navigate, and consistent with the current experience
- Task: Implement the redirect strategy so that current dynamic links do not break
- Quarter 2 report: all (not trivial) tasks done
- Consolidate discussion options to the Forum
- Define the forum target links and tags HOT 1
- Evaluate SEO impact and type of forum links to use HOT 7
- GitHub search to find old Google Group, Freenode & Libera.chat references HOT 3
- Update repos with forum links
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from community-team.