Do extra docs validation; explicitly disallow semantic markup in docs #165
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
Codecov Report
@@ Coverage Diff @@
## main #165 +/- ##
=======================================
Coverage 84.57% 84.57%
=======================================
Files 32 32
Lines 3850 3850
Branches 710 710
=======================================
Hits 3256 3256
Misses 456 456
Partials 138 138
Flags with carried forward coverage won't be shown. Click here to find out more. Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
This reverts commit 445c56e.
Backport to stable-1: 💚 backport PR created✅ Backport PR branch: Backported as #167 🤖 @patchback |
patchback bot
pushed a commit
that referenced
this pull request
Apr 16, 2023
…#165) * Do extra docs validation. Explicitly disallow semantic markup in docs. * Forgot to add new requirement. * Improve test. * TEMP - make CI fail. * Remove unnecessary import. * Make sure ANSIBLE_COLLECTIONS_PATH is set. * Revert "TEMP - make CI fail." This reverts commit 445c56e. * Make sure sanity tests from older Ansible versions don't complain. (cherry picked from commit dd1e48c)
felixfontein
added a commit
that referenced
this pull request
Apr 16, 2023
…#165) (#167) * Do extra docs validation. Explicitly disallow semantic markup in docs. * Forgot to add new requirement. * Improve test. * TEMP - make CI fail. * Remove unnecessary import. * Make sure ANSIBLE_COLLECTIONS_PATH is set. * Revert "TEMP - make CI fail." This reverts commit 445c56e. * Make sure sanity tests from older Ansible versions don't complain. (cherry picked from commit dd1e48c) Co-authored-by: Felix Fontein <[email protected]>
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.
SUMMARY
Use
antsibull-docs lint-collection-docs --plugin-docsto do additional documentation validation. This is important if the docs build workflow is no longer there (#6344).This also ensures that no semantic markup is used. This should be changed once the last Ansible 6.x.y release is out containing this collection; from then on we can (relatively) safely start using semantic markup without defacing the Ansible 7 (or before) documentation.
ISSUE TYPE
COMPONENT NAME
CI