docs: Run rstcheck on the README.rst #26454
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When trying to run rstcheck on the README.rst, it reports two sets of duplicate explicit target names. Indeed, we have two links that each appear twice, with the same URLs and target names. This is not a good practice, given that it makes more locations to update if we ever need to update one of these URLs. Instead, let's keep the URLs once and have the references point to it. This way we can also move the URLs out of the RST paragraph, to make the text file easier to read. Signed-off-by: Quentin Monnet <quentin@isovalent.com>
Let's run rstcheck on the README.rst file in addition to the documentation sources. One motivation is to help catch issues on the releases table before merging. We update this table with a script after cutting new releases, and it has occasionally led to formatting issues in the past. Fixes: cilium#13366 Signed-off-by: Quentin Monnet <quentin@isovalent.com>
qmonnet
added
area/documentation
This was referenced Jun 23, 2023
borkmann
approved these changes
Jun 26, 2023
learnitall
approved these changes
Jun 26, 2023
borkmann
added
the
ready-to-merge
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Commits:
This is to make sure we catch issues on the formatting of the releases table before merging, see #13366.