Migrates scenario guide from ansible/ansible repo #362

acozine · 2021-05-07T16:47:02Z

SUMMARY

Related to ansible-community/antsibull#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

tremble

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?

tremble · 2021-05-12T07:19:25Z

docs/docsite/rst/guide_aws.rst

+   `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


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

tremble · 2021-05-12T07:20:32Z

docs/docsite/rst/guide_aws.rst

+    - ec2
+      aws_access_key: "{{ec2_access_key}}"
+      aws_secret_key: "{{ec2_secret_key}}"
+      image: "..."


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

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.

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

tremble · 2021-05-15T10:58:57Z

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

acozine · 2021-05-16T00:18:18Z

@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 · 2021-05-17T16:03:45Z

@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 · 2021-05-17T16:09:58Z

@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 · 2021-05-17T20:39:34Z

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 · 2021-05-17T20:43:31Z

@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.

* 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

jillr · 2021-06-24T18:26:04Z

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 · 2021-06-24T21:00:34Z

recheck

* 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

* 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

* 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 · 2021-07-02T16:49:41Z

recheck

* 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

* 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 marked this pull request as draft May 7, 2021 16:47

tremble approved these changes May 12, 2021

View reviewed changes

This was referenced May 14, 2021

Moves the AWS Scenario Guide out of the main docs ansible/ansible#74704

Merged

DaWGs (Documentation Working Group) Meeting Agenda 2021 ansible/community#579

Closed

ansibullbot added WIP Work in progress docs has_issue needs_triage labels May 21, 2021

goneri removed the needs_triage label May 25, 2021

dmsimard mentioned this pull request May 26, 2021

Community Working Group Meeting Agenda ansible/community#539

Closed

acozine changed the title ~~WIP: migrates scenario guide from ansible/ansible repo~~ Migrates scenario guide from ansible/ansible repo Jun 24, 2021

ansibullbot added community_review and removed WIP Work in progress labels Jun 24, 2021

acozine marked this pull request as ready for review June 24, 2021 15:53

migrates scenario guide from ansible/ansible repo

0773eb7

acozine deleted the migrate_scenario_guide branch August 11, 2021 19:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrates scenario guide from ansible/ansible repo #362

Migrates scenario guide from ansible/ansible repo #362

acozine commented May 7, 2021 •

edited by jillr

Loading

tremble left a comment

tremble May 12, 2021

jillr May 14, 2021

tremble May 12, 2021

acozine May 13, 2021

acozine May 13, 2021

tremble commented May 15, 2021

acozine commented May 16, 2021

jillr commented May 17, 2021

acozine commented May 17, 2021

goneri commented May 17, 2021

jillr commented May 17, 2021

jillr commented Jun 24, 2021

jillr commented Jun 24, 2021

jillr commented Jul 2, 2021

Migrates scenario guide from ansible/ansible repo #362

Migrates scenario guide from ansible/ansible repo #362

Conversation

acozine commented May 7, 2021 • edited by jillr Loading

SUMMARY

ISSUE TYPE

COMPONENT NAME

tremble left a comment

Choose a reason for hiding this comment

tremble May 12, 2021

Choose a reason for hiding this comment

jillr May 14, 2021

Choose a reason for hiding this comment

tremble May 12, 2021

Choose a reason for hiding this comment

acozine May 13, 2021

Choose a reason for hiding this comment

acozine May 13, 2021

Choose a reason for hiding this comment

tremble commented May 15, 2021

acozine commented May 16, 2021

jillr commented May 17, 2021

acozine commented May 17, 2021

goneri commented May 17, 2021

jillr commented May 17, 2021

jillr commented Jun 24, 2021

jillr commented Jun 24, 2021

jillr commented Jul 2, 2021

acozine commented May 7, 2021 •

edited by jillr

Loading