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

[Part #5] Ensures the modules documentation follows the correct formats #2087

Conversation

alinabuzachis
Copy link
Collaborator

SUMMARY

Ensures the modules documentation follows the correct formats

ISSUE TYPE
  • Bugfix Pull Request
  • Docs Pull Request
  • Feature Pull Request
  • New Module Pull Request
COMPONENT NAME
ADDITIONAL INFORMATION

Copy link

github-actions bot commented May 13, 2024

Docs Build 📝

Thank you for contribution!✨

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

Copy link
Contributor

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/948cb4e51f744bdea41f0e1727374e74

✔️ ansible-galaxy-importer SUCCESS in 4m 43s
✔️ build-ansible-collection SUCCESS in 19m 48s
✔️ ansible-test-splitter SUCCESS in 8m 48s
integration-amazon.aws-1 FAILURE in 12m 12s
✔️ integration-amazon.aws-2 SUCCESS in 12m 51s
✔️ integration-amazon.aws-3 SUCCESS in 8m 32s
✔️ integration-amazon.aws-4 SUCCESS in 7m 11s
integration-amazon.aws-5 RETRY_LIMIT in 6m 57s
✔️ integration-amazon.aws-6 SUCCESS in 7m 42s
✔️ integration-amazon.aws-7 SUCCESS in 6m 14s
✔️ integration-amazon.aws-8 SUCCESS in 6m 50s
✔️ integration-amazon.aws-9 SUCCESS in 8m 16s
✔️ integration-amazon.aws-10 SUCCESS in 6m 15s
✔️ integration-amazon.aws-11 SUCCESS in 6m 04s
✔️ integration-amazon.aws-12 SUCCESS in 10m 01s
✔️ integration-amazon.aws-13 SUCCESS in 5m 53s
Skipped 31 jobs

Copy link
Contributor

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/81fe7d739c844a179c429f0db5b507a3

✔️ ansible-galaxy-importer SUCCESS in 6m 01s
✔️ build-ansible-collection SUCCESS in 18m 18s
✔️ ansible-test-splitter SUCCESS in 6m 31s
✔️ integration-amazon.aws-1 SUCCESS in 13m 33s
✔️ integration-amazon.aws-2 SUCCESS in 11m 38s
✔️ integration-amazon.aws-3 SUCCESS in 10m 09s
✔️ integration-amazon.aws-4 SUCCESS in 6m 03s
✔️ integration-amazon.aws-5 SUCCESS in 6m 48s
✔️ integration-amazon.aws-6 SUCCESS in 5m 50s
✔️ integration-amazon.aws-7 SUCCESS in 9m 32s
✔️ integration-amazon.aws-8 SUCCESS in 7m 46s
✔️ integration-amazon.aws-9 SUCCESS in 11m 53s
✔️ integration-amazon.aws-10 SUCCESS in 7m 30s
✔️ integration-amazon.aws-11 SUCCESS in 10m 06s
✔️ integration-amazon.aws-12 SUCCESS in 5m 29s
✔️ integration-amazon.aws-13 SUCCESS in 7m 05s
Skipped 31 jobs

Copy link
Contributor

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/f834248bb6e6416a8270b2fa13a9ae17

✔️ ansible-galaxy-importer SUCCESS in 3m 53s
✔️ build-ansible-collection SUCCESS in 12m 30s
✔️ ansible-test-splitter SUCCESS in 4m 57s
✔️ integration-amazon.aws-1 SUCCESS in 12m 40s
✔️ integration-amazon.aws-2 SUCCESS in 11m 43s
✔️ integration-amazon.aws-3 SUCCESS in 8m 44s
✔️ integration-amazon.aws-4 SUCCESS in 6m 19s
✔️ integration-amazon.aws-5 SUCCESS in 6m 28s
✔️ integration-amazon.aws-6 SUCCESS in 6m 06s
✔️ integration-amazon.aws-7 SUCCESS in 6m 28s
✔️ integration-amazon.aws-8 SUCCESS in 10m 25s
✔️ integration-amazon.aws-9 SUCCESS in 7m 25s
✔️ integration-amazon.aws-10 SUCCESS in 5m 17s
✔️ integration-amazon.aws-11 SUCCESS in 5m 44s
✔️ integration-amazon.aws-12 SUCCESS in 5m 34s
✔️ integration-amazon.aws-13 SUCCESS in 6m 02s
Skipped 31 jobs

@alinabuzachis alinabuzachis requested a review from tremble June 26, 2024 09:44
Copy link
Contributor

@hakbailey hakbailey left a comment

Choose a reason for hiding this comment

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

Just a few minor typos, otherwise this looks good!

plugins/modules/kms_key_info.py Outdated Show resolved Hide resolved
plugins/modules/lambda_layer.py Outdated Show resolved Hide resolved
plugins/modules/route53.py Outdated Show resolved Hide resolved
plugins/modules/route53.py Outdated Show resolved Hide resolved
Copy link
Contributor

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/20d2eb2f709b4f0ab2bee2eb992f2811

✔️ ansible-galaxy-importer SUCCESS in 5m 08s
✔️ build-ansible-collection SUCCESS in 12m 32s
✔️ ansible-test-splitter SUCCESS in 5m 04s
✔️ integration-amazon.aws-1 SUCCESS in 12m 48s
✔️ integration-amazon.aws-2 SUCCESS in 11m 07s
✔️ integration-amazon.aws-3 SUCCESS in 9m 13s
✔️ integration-amazon.aws-4 SUCCESS in 5m 10s
✔️ integration-amazon.aws-5 SUCCESS in 5m 20s
✔️ integration-amazon.aws-6 SUCCESS in 6m 23s
✔️ integration-amazon.aws-7 SUCCESS in 6m 25s
✔️ integration-amazon.aws-8 SUCCESS in 6m 56s
✔️ integration-amazon.aws-9 SUCCESS in 11m 01s
✔️ integration-amazon.aws-10 SUCCESS in 8m 43s
✔️ integration-amazon.aws-11 SUCCESS in 6m 41s
✔️ integration-amazon.aws-12 SUCCESS in 5m 34s
✔️ integration-amazon.aws-13 SUCCESS in 6m 21s
Skipped 31 jobs

plugins/modules/kms_key.py Outdated Show resolved Hide resolved
plugins/modules/kms_key_info.py Outdated Show resolved Hide resolved
plugins/modules/lambda_execute.py Outdated Show resolved Hide resolved
plugins/modules/route53.py Outdated Show resolved Hide resolved
plugins/modules/route53_health_check.py Show resolved Hide resolved
@@ -112,8 +112,8 @@
transform_location:
description:
- S3 bucket location for default us-east-1 is normally reported as C(null).
- Setting this option to C(true) will return C(us-east-1) instead.
- Affects only queries with I(bucket_facts=true) and I(bucket_location=true).
- Setting this option to V(true) will return C(us-east-1) instead.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- Setting this option to V(true) will return C(us-east-1) instead.
- Setting this option to V(true) will return RV(us-east-1) instead.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

us-east-1 is not a returned value really. If I use RV(), the documentation building step will fail. I use V() instead.

plugins/modules/s3_object.py Outdated Show resolved Hide resolved
@alinabuzachis alinabuzachis force-pushed the docs_update_5 branch 2 times, most recently from 308a4c5 to 34cf2d7 Compare June 27, 2024 13:42
Copy link
Contributor

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/0b9a62a6bf2e4d27ad8432e2a0a91872

✔️ ansible-galaxy-importer SUCCESS in 4m 12s
✔️ build-ansible-collection SUCCESS in 12m 23s
✔️ ansible-test-splitter SUCCESS in 4m 50s
✔️ integration-amazon.aws-1 SUCCESS in 12m 42s
✔️ integration-amazon.aws-2 SUCCESS in 16m 10s
✔️ integration-amazon.aws-3 SUCCESS in 13m 05s
✔️ integration-amazon.aws-4 SUCCESS in 12m 42s
✔️ integration-amazon.aws-5 SUCCESS in 6m 36s
✔️ integration-amazon.aws-6 SUCCESS in 6m 09s
✔️ integration-amazon.aws-7 SUCCESS in 6m 22s
✔️ integration-amazon.aws-8 SUCCESS in 5m 48s
✔️ integration-amazon.aws-9 SUCCESS in 8m 17s
✔️ integration-amazon.aws-10 SUCCESS in 6m 32s
✔️ integration-amazon.aws-11 SUCCESS in 5m 01s
✔️ integration-amazon.aws-12 SUCCESS in 4m 31s
✔️ integration-amazon.aws-13 SUCCESS in 5m 57s
Skipped 31 jobs

Copy link
Contributor

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/cf51f26a312249b28d9db0711a23096b

✔️ ansible-galaxy-importer SUCCESS in 4m 29s
✔️ build-ansible-collection SUCCESS in 12m 51s
✔️ ansible-test-splitter SUCCESS in 5m 05s
✔️ integration-amazon.aws-1 SUCCESS in 11m 52s
✔️ integration-amazon.aws-2 SUCCESS in 14m 24s
✔️ integration-amazon.aws-3 SUCCESS in 8m 46s
✔️ integration-amazon.aws-4 SUCCESS in 9m 30s
✔️ integration-amazon.aws-5 SUCCESS in 6m 30s
✔️ integration-amazon.aws-6 SUCCESS in 9m 30s
✔️ integration-amazon.aws-7 SUCCESS in 6m 13s
✔️ integration-amazon.aws-8 SUCCESS in 6m 08s
✔️ integration-amazon.aws-9 SUCCESS in 11m 04s
✔️ integration-amazon.aws-10 SUCCESS in 6m 03s
✔️ integration-amazon.aws-11 SUCCESS in 6m 31s
✔️ integration-amazon.aws-12 SUCCESS in 5m 51s
✔️ integration-amazon.aws-13 SUCCESS in 6m 30s
Skipped 31 jobs

@alinabuzachis alinabuzachis added the mergeit Merge the PR (SoftwareFactory) label Jun 27, 2024
Copy link
Contributor

Build succeeded (gate pipeline).
https://ansible.softwarefactory-project.io/zuul/buildset/fc4124cae37b402fb994e66b63ff757d

✔️ ansible-galaxy-importer SUCCESS in 5m 20s
✔️ build-ansible-collection SUCCESS in 12m 20s
✔️ ansible-test-splitter SUCCESS in 4m 52s
✔️ integration-amazon.aws-1 SUCCESS in 13m 11s
✔️ integration-amazon.aws-2 SUCCESS in 11m 18s
✔️ integration-amazon.aws-3 SUCCESS in 14m 32s
✔️ integration-amazon.aws-4 SUCCESS in 5m 35s
✔️ integration-amazon.aws-5 SUCCESS in 12m 40s
✔️ integration-amazon.aws-6 SUCCESS in 5m 17s
✔️ integration-amazon.aws-7 SUCCESS in 12m 54s
✔️ integration-amazon.aws-8 SUCCESS in 6m 25s
✔️ integration-amazon.aws-9 SUCCESS in 13m 40s
✔️ integration-amazon.aws-10 SUCCESS in 5m 49s
✔️ integration-amazon.aws-11 SUCCESS in 6m 29s
✔️ integration-amazon.aws-12 SUCCESS in 5m 40s
✔️ integration-amazon.aws-13 SUCCESS in 6m 41s
Skipped 31 jobs

@softwarefactory-project-zuul softwarefactory-project-zuul bot merged commit 7a487f5 into ansible-collections:main Jun 27, 2024
37 checks passed
@tremble tremble added the backport-8 PR should be backported to the stable-8 branch label Aug 27, 2024
Copy link

patchback bot commented Aug 27, 2024

Backport to stable-8: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-8/7a487f5adbf7a365beaa92650600c4f2ca780c33/pr-2087

Backported as #2242

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Aug 27, 2024
…ts (#2087)

SUMMARY

Ensures the modules documentation follows the correct formats

ISSUE TYPE

Bugfix Pull Request
Docs Pull Request
Feature Pull Request
New Module Pull Request

COMPONENT NAME

ADDITIONAL INFORMATION

Reviewed-by: Mandar Kulkarni <[email protected]>
Reviewed-by: Helen Bailey <[email protected]>
Reviewed-by: GomathiselviS
Reviewed-by: Alina Buzachis
(cherry picked from commit 7a487f5)
softwarefactory-project-zuul bot pushed a commit that referenced this pull request Aug 27, 2024
…ts (#2087) (#2242)

This is a backport of PR #2087 as merged into main (7a487f5).
SUMMARY

Ensures the modules documentation follows the correct formats

ISSUE TYPE


Bugfix Pull Request
Docs Pull Request
Feature Pull Request
New Module Pull Request

COMPONENT NAME

ADDITIONAL INFORMATION

Reviewed-by: Mark Chappell
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8 PR should be backported to the stable-8 branch mergeit Merge the PR (SoftwareFactory)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants