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.

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

Add docs for automatin rules #6072

Merged
merged 9 commits into from Nov 19, 2019
Merged

Conversation

stsewd
Copy link
Member

@stsewd stsewd commented Aug 14, 2019

Closes #6059

Should be merged after #5996 and friends are merged

docs/Makefile Outdated
@@ -2,7 +2,7 @@
#

# You can set these variables from the command line.
SPHINXOPTS = -W --keep-going
SPHINXOPTS = -W
Copy link
Member Author

@stsewd stsewd Aug 14, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This causes make livehtml to fail

- Action: ``Activate version on match``

Activate all new tags that don't contain the ``-nightly`` suffix
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Copy link
Member Author

@stsewd stsewd Aug 14, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is a very common case, we can add new actions like Activate versions that don't match

Copy link
Member Author

@stsewd stsewd Aug 14, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or an option for the rule like Match or Not match

Copy link
Member

@humitos humitos Aug 14, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove this example from the docs for now. Looks pretty complex to me and I'm not sure how many cases there are where -nightly is a tag.

Copy link
Member Author

@stsewd stsewd Aug 14, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The section is supposed to have complex examples, more than the suffix, is to have an example of how apply a rule on not-match

Copy link
Member Author

@stsewd stsewd Nov 6, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm suggesting #6354 to make this more easy

Copy link
Member

@humitos humitos left a comment

Looks good to me.

I think it would be good to start explaining what is each thing as a first paragraph of each section and then talk about it's limitation, the supported values and more advanced things. As a reader, it's important to know what a "Match" field is and then know what I can write on it.

Also, since the docs talks about "Creating a rule", it may be good to explain how to Delete a rule and what happens with the order in that case, for example.

docs/automation-rules.rst Outdated Show resolved Hide resolved
docs/automation-rules.rst Outdated Show resolved Hide resolved
docs/automation-rules.rst Outdated Show resolved Hide resolved
docs/automation-rules.rst Outdated Show resolved Hide resolved
docs/automation-rules.rst Outdated Show resolved Hide resolved
docs/automation-rules.rst Show resolved Hide resolved
docs/automation-rules.rst Show resolved Hide resolved
docs/automation-rules.rst Show resolved Hide resolved
docs/automation-rules.rst Outdated Show resolved Hide resolved
- Action: ``Activate version on match``

Activate all new tags that don't contain the ``-nightly`` suffix
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Copy link
Member

@humitos humitos Aug 14, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove this example from the docs for now. Looks pretty complex to me and I'm not sure how many cases there are where -nightly is a tag.

@stsewd stsewd requested a review from Aug 14, 2019
@stale
Copy link

@stale stale bot commented Sep 28, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Status: stale label Sep 28, 2019
@saadmk11 saadmk11 removed the Status: stale label Sep 28, 2019
@agjohnson agjohnson added the Status: blocked label Oct 15, 2019
@stsewd stsewd removed the Status: blocked label Nov 6, 2019
Copy link
Contributor

@agjohnson agjohnson left a comment

Docs look great! I noted a number of copy changes to make the docs more clear to both community users and commercial users. The voice of the docs seems to target the more technical crowd.

docs/automation-rules.rst Outdated Show resolved Hide resolved
docs/automation-rules.rst Outdated Show resolved Hide resolved
docs/automation-rules.rst Outdated Show resolved Hide resolved
docs/automation-rules.rst Outdated Show resolved Hide resolved
docs/automation-rules.rst Outdated Show resolved Hide resolved
docs/automation-rules.rst Outdated Show resolved Hide resolved
docs/automation-rules.rst Outdated Show resolved Hide resolved
docs/automation-rules.rst Outdated Show resolved Hide resolved
docs/automation-rules.rst Outdated Show resolved Hide resolved
docs/automation-rules.rst Outdated Show resolved Hide resolved
stsewd and others added 4 commits Nov 13, 2019
@stsewd stsewd requested a review from agjohnson Nov 14, 2019
Copy link
Member

@ericholscher ericholscher left a comment

I think this looks good. We need to ship it before release for it to be in stable, so merging 👍

@ericholscher ericholscher merged commit 9353efb into readthedocs:master Nov 19, 2019
2 checks passed
@stsewd stsewd deleted the docs-automation-rules branch Nov 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants