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

Refacter docs fragments and synchronize modules and plugins #1248

Conversation

tremble
Copy link
Contributor

@tremble tremble commented Nov 5, 2022

SUMMARY

Move some of our docs fragments about to better reflect what they're for and the fact that we now have our own "amazon.aws..." namespace we can use.

  • Synchronises the modules and plugins docs fragments (as far as possible)
  • Updates plugin docs fragments to reflect the previously announced env variable deprecations

Note: the amazon.aws.common.plugins fragment will necessitate some changes to the inventory and lookup plugins before use. (See also #1225). However, those changes will then bring them in line with the other modules

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

plugins/docs_fragments

ADDITIONAL INFORMATION

@github-actions
Copy link

github-actions bot commented Nov 5, 2022

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and your docs changes will be incorporated when they are next published.

@tremble tremble mentioned this pull request Nov 5, 2022
@tremble tremble changed the title Move docs fragments about Refacter docs fragments and synchronize modules and plugins Nov 5, 2022
@tremble tremble force-pushed the refacter/docs_fragments branch 2 times, most recently from 3410799 to 2e5ab47 Compare November 5, 2022 12:12
@tremble
Copy link
Contributor Author

tremble commented Nov 5, 2022

@alinabuzachis While I can't make the botocore/boto3 requirements come directly from requirements.txt, I have found a way to make the docs and code automatically stay in sync.

@softwarefactory-project-zuul

This comment was marked as resolved.

@softwarefactory-project-zuul

This comment was marked as resolved.

@tremble tremble force-pushed the refacter/docs_fragments branch 2 times, most recently from 562b9b5 to 6ef29d4 Compare November 5, 2022 14:20
@ansibullbot ansibullbot added the lookup lookup plugin label Nov 5, 2022
@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded.

✔️ ansible-galaxy-importer SUCCESS in 4m 27s
✔️ build-ansible-collection SUCCESS in 5m 27s
✔️ ansible-test-sanity-aws-ansible-python38 SUCCESS in 9m 09s
✔️ ansible-test-sanity-aws-ansible-2.12-python38 SUCCESS in 12m 14s
✔️ ansible-test-sanity-aws-ansible-2.13-python38 SUCCESS in 11m 51s
✔️ ansible-test-sanity-aws-ansible-2.14 SUCCESS in 8m 39s
✔️ ansible-test-units-amazon-aws-python36 SUCCESS in 6m 02s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 7m 18s
✔️ ansible-test-units-amazon-aws-python39 SUCCESS in 5m 54s
✔️ cloud-tox-py3 SUCCESS in 3m 16s
✔️ ansible-test-splitter SUCCESS in 2m 40s
✔️ integration-amazon.aws-1 SUCCESS in 6m 14s
⚠️ integration-amazon.aws-2 SKIPPED
⚠️ integration-amazon.aws-3 SKIPPED
⚠️ integration-amazon.aws-4 SKIPPED
⚠️ integration-amazon.aws-5 SKIPPED
⚠️ integration-amazon.aws-6 SKIPPED
⚠️ integration-amazon.aws-7 SKIPPED
⚠️ integration-amazon.aws-8 SKIPPED
⚠️ integration-amazon.aws-9 SKIPPED
⚠️ integration-amazon.aws-10 SKIPPED
⚠️ integration-amazon.aws-11 SKIPPED
⚠️ integration-amazon.aws-12 SKIPPED
⚠️ integration-amazon.aws-13 SKIPPED
⚠️ integration-amazon.aws-14 SKIPPED
⚠️ integration-amazon.aws-15 SKIPPED
⚠️ integration-amazon.aws-16 SKIPPED
⚠️ integration-amazon.aws-17 SKIPPED
⚠️ integration-amazon.aws-18 SKIPPED
⚠️ integration-amazon.aws-19 SKIPPED
⚠️ integration-amazon.aws-20 SKIPPED
⚠️ integration-amazon.aws-21 SKIPPED
⚠️ integration-amazon.aws-22 SKIPPED
⚠️ integration-community.aws-1 SKIPPED
⚠️ integration-community.aws-2 SKIPPED
⚠️ integration-community.aws-3 SKIPPED
⚠️ integration-community.aws-4 SKIPPED
⚠️ integration-community.aws-5 SKIPPED
⚠️ integration-community.aws-6 SKIPPED
⚠️ integration-community.aws-7 SKIPPED
⚠️ integration-community.aws-8 SKIPPED
⚠️ integration-community.aws-9 SKIPPED
⚠️ integration-community.aws-10 SKIPPED
⚠️ integration-community.aws-11 SKIPPED
⚠️ integration-community.aws-12 SKIPPED
⚠️ integration-community.aws-13 SKIPPED
⚠️ integration-community.aws-14 SKIPPED
⚠️ integration-community.aws-15 SKIPPED
⚠️ integration-community.aws-16 SKIPPED
⚠️ integration-community.aws-17 SKIPPED
⚠️ integration-community.aws-18 SKIPPED
⚠️ integration-community.aws-19 SKIPPED
⚠️ integration-community.aws-20 SKIPPED
⚠️ integration-community.aws-21 SKIPPED
⚠️ integration-community.aws-22 SKIPPED
✔️ ansible-test-changelog SUCCESS in 2m 17s
✔️ noop SUCCESS in 0s

@tremble tremble marked this pull request as ready for review November 5, 2022 15:24
@tremble tremble added the mergeit Merge the PR (SoftwareFactory) label Nov 7, 2022
@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded (gate pipeline).

✔️ ansible-galaxy-importer SUCCESS in 4m 23s
✔️ build-ansible-collection SUCCESS in 5m 42s
✔️ ansible-test-sanity-aws-ansible-python38 SUCCESS in 8m 28s
✔️ ansible-test-sanity-aws-ansible-2.12-python38 SUCCESS in 10m 02s
✔️ ansible-test-sanity-aws-ansible-2.13-python38 SUCCESS in 10m 50s
✔️ ansible-test-sanity-aws-ansible-2.14 SUCCESS in 12m 14s
✔️ ansible-test-units-amazon-aws-python36 SUCCESS in 7m 24s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 6m 09s
✔️ ansible-test-units-amazon-aws-python39 SUCCESS in 6m 08s
✔️ cloud-tox-py3 SUCCESS in 3m 08s
✔️ ansible-test-splitter SUCCESS in 2m 48s
✔️ integration-amazon.aws-1 SUCCESS in 6m 14s
⚠️ integration-amazon.aws-2 SKIPPED
⚠️ integration-amazon.aws-3 SKIPPED
⚠️ integration-amazon.aws-4 SKIPPED
⚠️ integration-amazon.aws-5 SKIPPED
⚠️ integration-amazon.aws-6 SKIPPED
⚠️ integration-amazon.aws-7 SKIPPED
⚠️ integration-amazon.aws-8 SKIPPED
⚠️ integration-amazon.aws-9 SKIPPED
⚠️ integration-amazon.aws-10 SKIPPED
⚠️ integration-amazon.aws-11 SKIPPED
⚠️ integration-amazon.aws-12 SKIPPED
⚠️ integration-amazon.aws-13 SKIPPED
⚠️ integration-amazon.aws-14 SKIPPED
⚠️ integration-amazon.aws-15 SKIPPED
⚠️ integration-amazon.aws-16 SKIPPED
⚠️ integration-amazon.aws-17 SKIPPED
⚠️ integration-amazon.aws-18 SKIPPED
⚠️ integration-amazon.aws-19 SKIPPED
⚠️ integration-amazon.aws-20 SKIPPED
⚠️ integration-amazon.aws-21 SKIPPED
⚠️ integration-amazon.aws-22 SKIPPED
⚠️ integration-community.aws-1 SKIPPED
⚠️ integration-community.aws-2 SKIPPED
⚠️ integration-community.aws-3 SKIPPED
⚠️ integration-community.aws-4 SKIPPED
⚠️ integration-community.aws-5 SKIPPED
⚠️ integration-community.aws-6 SKIPPED
⚠️ integration-community.aws-7 SKIPPED
⚠️ integration-community.aws-8 SKIPPED
⚠️ integration-community.aws-9 SKIPPED
⚠️ integration-community.aws-10 SKIPPED
⚠️ integration-community.aws-11 SKIPPED
⚠️ integration-community.aws-12 SKIPPED
⚠️ integration-community.aws-13 SKIPPED
⚠️ integration-community.aws-14 SKIPPED
⚠️ integration-community.aws-15 SKIPPED
⚠️ integration-community.aws-16 SKIPPED
⚠️ integration-community.aws-17 SKIPPED
⚠️ integration-community.aws-18 SKIPPED
⚠️ integration-community.aws-19 SKIPPED
⚠️ integration-community.aws-20 SKIPPED
⚠️ integration-community.aws-21 SKIPPED
⚠️ integration-community.aws-22 SKIPPED
✔️ ansible-test-changelog SUCCESS in 2m 17s
✔️ noop SUCCESS in 0s

@softwarefactory-project-zuul softwarefactory-project-zuul bot merged commit ca77bcf into ansible-collections:main Nov 7, 2022
softwarefactory-project-zuul bot pushed a commit that referenced this pull request Nov 7, 2022
Refacter lookup plugins

Depends-On: #1248
SUMMARY

Refacters the lookup plugins to use common code for common boto3/botocore operations

ISSUE TYPE

Feature Pull Request

COMPONENT NAME
plugins/lookup/aws_account_attribute.py
plugins/lookup/aws_secret.py
plugins/lookup/aws_ssm.py
plugins/module_utils/botocore.py
plugins/module_utils/core.py
plugins/module_utils/exceptions.py
plugins/module_utils/modules.py
ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis <None>
Reviewed-by: Mark Chappell <None>
@tremble tremble deleted the refacter/docs_fragments branch February 15, 2023 09:02
softwarefactory-project-zuul bot pushed a commit that referenced this pull request Feb 22, 2023
Bulk update to renamed docs fragments

SUMMARY
Follow up to #1248, we renamed various docs fragments, clean-up amazon.aws
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
various
ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community_review docs lookup lookup plugin mergeit Merge the PR (SoftwareFactory) module_utils module_utils needs_triage new_plugin New plugin plugins plugin (any type)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants