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

Migrates scenario guide from ansible/ansible repo #362

Merged

Conversation

acozine
Copy link
Contributor

@acozine acozine commented May 7, 2021

SUMMARY

Related to ansible-community/antsibull-build#255.

Do we need to rename the page index.rst? Or add an index.rst file?

Also needs a PR against ansible/ansible removing this content from there.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

docs.ansible.com

Depends-On: ansible/ansible-zuul-jobs#962

@acozine acozine marked this pull request as draft May 7, 2021 16:47
Copy link
Contributor

@tremble tremble left a comment

Choose a reason for hiding this comment

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

The change itself looks fine to me.

@jillr I've dropped a couple of comments inline - I don't think they should be part of this PR (in the interests of keeping it clean and simple), do you think they're worth following up on?

`User Mailing List <https://groups.google.com/group/ansible-devel>`_
Have a question? Stop by the google group!
`irc.freenode.net <http://irc.freenode.net>`_
#ansible IRC chat channel
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we want to update this to #ansible-aws ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Definitely

- ec2
aws_access_key: "{{ec2_access_key}}"
aws_secret_key: "{{ec2_secret_key}}"
image: "..."
Copy link
Contributor

Choose a reason for hiding this comment

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

I guess we'll want to update this to recommend the use of module_defaults?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for spotting that @tremble! The guide will need sundry updates to the content. The purpose of this PR is mainly to get it moved, and to serve as an example of how to move other Scenario Guides.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@tremble - Ignore my comment - I just saw your overall review comment . . .

@tremble
Copy link
Contributor

tremble commented May 15, 2021

@acozine This PR's currently flagged as draft, should we wait on something before merging this?

@acozine
Copy link
Contributor Author

acozine commented May 16, 2021

@tremble it's waiting on the antsibull PR listed above. Once that is tested and merged, we can publish .rst docs from collections to docs.ansible.com.

@jillr
Copy link
Collaborator

jillr commented May 17, 2021

@acozine will we need to duplicate this doc in community.aws? If I'm understanding antsibull/pull/255 there will no longer be anything at https://docs.ansible.com/ansible/devel/scenario_guides/guide_aws.html and folks will have to look under the specific collection for the guides? I don't love the idea of duplicating it, but I'm trying to think through what the best thing for our users is.

@acozine
Copy link
Contributor Author

acozine commented May 17, 2021

@jillr yes, the idea here is to move the Scenario Guides into the collections that provide the functionality described in the guides. The content would be published to docs.ansible.com with the collection-based module documentation.

We probably want to keep this content in one and only one collection, so either amazon.aws or community. aws. What is the difference between them? Does the content (for example, the dynamic inventory plugin) exist in both?

@goneri
Copy link
Member

goneri commented May 17, 2021

Can I suggest to use Sphinx-Ansible (https://sphinx-ansible.readthedocs.io/en/latest/) to be sure all the tasks work as expected? I understand it can be a bit of work and this is really just a suggestion.

@jillr
Copy link
Collaborator

jillr commented May 17, 2021

@acozine different modules in each. Supported modules/plugins are in amazon.aws, and community content is in community.aws. The general content in the user guide is the same for both collections (how to authenticate, etc). It could really stand to be updated (we want to discourage use of the ec2 module for example) but I'm not sure if we want/need two different guides. I'll think on that a bit.

jillr pushed a commit to jillr/amazon.aws that referenced this pull request Jun 21, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests
@acozine acozine changed the title WIP: migrates scenario guide from ansible/ansible repo Migrates scenario guide from ansible/ansible repo Jun 24, 2021
@ansibullbot ansibullbot added community_review and removed WIP Work in progress labels Jun 24, 2021
@acozine acozine marked this pull request as ready for review June 24, 2021 15:53
@jillr
Copy link
Collaborator

jillr commented Jun 24, 2021

The change itself looks fine to me.

@jillr I've dropped a couple of comments inline - I don't think they should be part of this PR (in the interests of keeping it clean and simple), do you think they're worth following up on?

I've added a task for myself to do the prose updates as part of the 2.0 release plan.

@jillr
Copy link
Collaborator

jillr commented Jun 24, 2021

recheck

goneri pushed a commit to goneri/amazon.aws that referenced this pull request Jun 25, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
goneri pushed a commit to goneri/amazon.aws that referenced this pull request Jun 25, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
-- 222 --
See: ansible-collections/community.aws@a89ec90
goneri pushed a commit to goneri/amazon.aws that referenced this pull request Jun 25, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
goneri pushed a commit to goneri/amazon.aws that referenced this pull request Jun 25, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
goneri pushed a commit to goneri/amazon.aws that referenced this pull request Jun 25, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
@jillr
Copy link
Collaborator

jillr commented Jul 2, 2021

recheck

alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Jul 20, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Jul 20, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Jul 20, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Jul 20, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Jul 20, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Aug 3, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Aug 3, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Aug 4, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Aug 4, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Aug 6, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Aug 6, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
@acozine acozine deleted the migrate_scenario_guide branch August 11, 2021 19:31
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Aug 12, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Aug 13, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Aug 13, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Aug 13, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Aug 23, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Aug 23, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Aug 23, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Aug 23, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Aug 23, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit that referenced this pull request Aug 25, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit that referenced this pull request Aug 25, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit that referenced this pull request Aug 25, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit that referenced this pull request Aug 26, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Aug 26, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
alinabuzachis pushed a commit to alinabuzachis/amazon.aws that referenced this pull request Aug 26, 2021
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections/community.aws@a89ec90
abikouo pushed a commit to abikouo/amazon.aws that referenced this pull request Sep 18, 2023
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests
abikouo pushed a commit to abikouo/amazon.aws that referenced this pull request Sep 18, 2023
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests
abikouo pushed a commit to abikouo/amazon.aws that referenced this pull request Oct 24, 2023
* Ensure ec2_vpc_endpoint returns True when deleting an Endpoint
Return not changed when state=absent and endpoint has already been deleted

* Add minimal endpoint tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants