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.

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

Clean up doc build warnings, add best practices for writing states #47860

Merged
merged 10 commits into from Jun 1, 2018

Conversation

Projects
None yet
4 participants
@terminalmage
Member

terminalmage commented May 29, 2018

This reduces the number of build warnings from 2986 to 1. We can't get rid of that last one because it is triggered due to our custom autofunction plugin (which overrides the default autofunction from Sphinx).

Additionally, this PR adds some best practices documentation for writing states.

@terminalmage terminalmage requested a review from saltstack/team-core as a code owner May 29, 2018

@terminalmage terminalmage force-pushed the terminalmage:state-writing-docs branch from 5b3361a to 46e0f9c May 29, 2018

@cachedout

This comment has been minimized.

Contributor

cachedout commented May 29, 2018

This is awesome!

Can you swing by and clean up a few lint errors, please?

@terminalmage

This comment has been minimized.

Member

terminalmage commented May 29, 2018

@cachedout lint is fixed

@cachedout

This comment has been minimized.

Contributor

cachedout commented May 29, 2018

Hmm. We went sideways on some tests here, too.

@terminalmage

This comment has been minimized.

Member

terminalmage commented May 30, 2018

@cachedout mocking just needed to be updated. I couldn't reproduce the gitfs unit test failures, and they don't seem to be related.

@rallytime

This comment has been minimized.

Contributor

rallytime commented May 30, 2018

2986 to 1 WOW!

@rallytime

This is awesome. We should figure out how to monitor for these kinds of warnings/errors on the doc build test. (Right now all it does is check for whether or not the docs can build - very simple, nothing fancy.)

@rallytime

This comment has been minimized.

Contributor

rallytime commented May 31, 2018

@terminalmage One final lint error to fix, and then this will be good.

terminalmage added some commits May 21, 2018

Fix all Sphinx warnings
Well, all but one, which we expect to see
Fix crappy mocking
This fixes some poorly-conceived mocking that was done because of some
equally dumb imports being done in salt/modules/junos.py (which I fixed
a few commits ago while in the process of cleaning up the docs).
Quiet the linter
We need this import to determine whether we have the needed modules to
run the test, even though it is not invoked directly.

@terminalmage terminalmage force-pushed the terminalmage:state-writing-docs branch from ceb0ad4 to 8cb33d3 May 31, 2018

@terminalmage

This comment has been minimized.

Member

terminalmage commented May 31, 2018

@rallytime should be fixed now.

@rallytime rallytime merged commit a2b5882 into saltstack:2017.7 Jun 1, 2018

6 of 9 checks passed

default Build finished.
Details
jenkins/PR/salt-pr-linode-cent7-py3 Pull Requests » Salt PR - Linode CentOS 7 - PY3 #5407 — FAILURE
Details
jenkins/PR/salt-pr-rs-cent7-n Pull Requests » Salt PR - RS CentOS 7 #19464 — FAILURE
Details
WIP ready for review
Details
jenkins/PR/salt-pr-clone Pull Requests » Salt PR - Clone #25604 — SUCCESS
Details
jenkins/PR/salt-pr-docs-n Pull Requests » Salt PR - Docs #17676 — SUCCESS
Details
jenkins/PR/salt-pr-linode-ubuntu14-n Pull Requests » Salt PR - Linode Ubuntu14.04 #23342 — SUCCESS
Details
jenkins/PR/salt-pr-linode-ubuntu16-py3 Pull Requests » Salt PR - Linode Ubuntu16.04 - PY3 #10380 — SUCCESS
Details
jenkins/PR/salt-pr-lint-n Pull Requests » Salt PR - Code Lint #22306 — SUCCESS
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment