Skip to content
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

Jump to bottom

Make new RST warnings fatal in Shippable #39030

Closed
acozine opened this issue Apr 19, 2018 · 2 comments
Closed

Make new RST warnings fatal in Shippable #39030

acozine opened this issue Apr 19, 2018 · 2 comments
Assignees
@abadger @mattclay @acozine @gundalow
Labels
affects_2.6 This issue/PR affects Ansible v2.6 docs This issue/PR relates to or includes documentation. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
Ansible-maintained Collections Docume...

Comments

@acozine
Copy link
Contributor

acozine commented Apr 19, 2018 •
edited

ISSUE TYPE
  • Documentation Report
COMPONENT NAME

docs.ansible.com

ANSIBLE VERSION

2.6

SUMMARY

We have a lot of legacy errors in the documentation build, so we are not treating rST warnings as fatal for the CI build. This leads me to ignore error output when I build the docs. And it means that we inevitably introduce both regressions and new errors.

We are working to eliminate as many legacy errors as possible. We will likely add an ignore list, then make new rST warnings fatal for the Shippable build when a PR makes changes to docs. With Shippable keeping us honest, we can identify regressions and new errors before they get merged.

ADDITIONAL INFO

Related to PRs #38979 and #38890 as well as multiple issues related to the a build error (#38893 and several others).
Gist of errors: https://gist.github.com/acozine/c09c09b5587569e76b7676d79f504e3f
@acozine acozine added the docs This issue/PR relates to or includes documentation. label Apr 19, 2018
@acozine acozine added this to Docsite work in Ansible-maintained Collections Documentation via automation Apr 19, 2018
@ansibot
Copy link
Contributor

ansibot commented Apr 19, 2018

Files identified in the description:
None

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

@ansibot ansibot added affects_2.6 This issue/PR affects Ansible v2.6 support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Apr 19, 2018
This was referenced Apr 19, 2018
Merged
Merged
Merged
Merged
Merged
@acozine
Copy link
Contributor Author

acozine commented Apr 20, 2018

Tests added in #39043. Thanks to @mattclay for keeping us on the straight and narrow!

@acozine acozine closed this as completed Apr 20, 2018
Ansible-maintained Collections Documentation automation moved this from Docsite work to Done Apr 20, 2018
This was referenced Apr 20, 2018
Merged
Merged
Merged
Merged
Merged
@ansible ansible locked and limited conversation to collaborators Apr 27, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@abadger abadger

@mattclay mattclay

@acozine acozine

@gundalow gundalow

Labels
affects_2.6 This issue/PR affects Ansible v2.6 docs This issue/PR relates to or includes documentation. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
No open projects
Ansible-maintained Collections Docume...
  
Done
Milestone
No milestone
Development

No branches or pull requests
6 participants
@abadger @mattclay @acozine @gundalow @dharmabumstead @ansibot