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.

Sign up for GitHub

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

Jump to bottom

[Part #1]: Ensures the modules documentation follows the correct formats #2080

Merged
merged 3 commits into from
May 22, 2024
Merged

[Part #1]: Ensures the modules documentation follows the correct formats #2080

merged 3 commits into from
May 22, 2024

Conversation

alinabuzachis
Copy link
Contributor

SUMMARY

Ensures the modules documentation follows the correct formats https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_documenting.html#semantic-markup-within-module-documentation

More PRs are yet to come

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME
ADDITIONAL INFORMATION

@alinabuzachis alinabuzachis changed the title Ensures the modules documentation follows the correct formats [Part #1]: Ensures the modules documentation follows the correct formats May 10, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented May 10, 2024 •
edited

Docs Build 📝

Thank you for contribution!✨

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

@alinabuzachis alinabuzachis force-pushed the docs_update_1 branch 5 times, most recently from 7723f8c to 41f526a Compare May 10, 2024 13:56
@softwarefactory-project-zuul softwarefactory-project-zuul
Copy link
Contributor

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

✔️ ansible-galaxy-importer SUCCESS in 5m 30s
✔️ build-ansible-collection SUCCESS in 16m 22s
✔️ ansible-test-splitter SUCCESS in 6m 47s
✔️ integration-amazon.aws-1 SUCCESS in 35m 11s
✔️ integration-amazon.aws-2 SUCCESS in 16m 15s
✔️ integration-amazon.aws-3 SUCCESS in 8m 40s
✔️ integration-amazon.aws-4 SUCCESS in 7m 33s
✔️ integration-amazon.aws-5 SUCCESS in 5m 32s
✔️ integration-amazon.aws-6 SUCCESS in 6m 20s
✔️ integration-amazon.aws-7 SUCCESS in 6m 57s
✔️ integration-amazon.aws-8 SUCCESS in 5m 33s
✔️ integration-amazon.aws-9 SUCCESS in 12m 06s
✔️ integration-amazon.aws-10 SUCCESS in 5m 28s
✔️ integration-amazon.aws-11 SUCCESS in 8m 25s
✔️ integration-amazon.aws-12 SUCCESS in 5m 35s
✔️ integration-amazon.aws-13 SUCCESS in 6m 00s
✔️ integration-amazon.aws-14 SUCCESS in 5m 49s
Skipped 30 jobs

tremble
tremble approved these changes May 13, 2024
View reviewed changes
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.

Some minor additional suggestions, but the change looks good.

plugins/modules/cloudformation.py Outdated Show resolved Hide resolved
plugins/modules/cloudformation.py Outdated Show resolved Hide resolved
plugins/modules/cloudformation.py Outdated Show resolved Hide resolved
plugins/modules/cloudwatch_metric_alarm_info.py Outdated Show resolved Hide resolved
plugins/modules/ec2_ami.py Outdated Show resolved Hide resolved
plugins/modules/ec2_ami.py Outdated Show resolved Hide resolved
plugins/modules/ec2_ami_info.py Outdated Show resolved Hide resolved
plugins/modules/ec2_ami_info.py Outdated Show resolved Hide resolved
@softwarefactory-project-zuul softwarefactory-project-zuul
Copy link
Contributor

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

✔️ ansible-galaxy-importer SUCCESS in 5m 44s
✔️ build-ansible-collection SUCCESS in 19m 16s
✔️ ansible-test-splitter SUCCESS in 10m 43s
✔️ integration-amazon.aws-1 SUCCESS in 27m 31s
✔️ integration-amazon.aws-2 SUCCESS in 17m 56s
✔️ integration-amazon.aws-3 SUCCESS in 7m 19s
✔️ integration-amazon.aws-4 SUCCESS in 7m 21s
✔️ integration-amazon.aws-5 SUCCESS in 9m 11s
❌ integration-amazon.aws-6 RETRY_LIMIT in 1m 38s
✔️ integration-amazon.aws-7 SUCCESS in 6m 37s
✔️ integration-amazon.aws-8 SUCCESS in 5m 30s
✔️ integration-amazon.aws-9 SUCCESS in 12m 21s
✔️ integration-amazon.aws-10 SUCCESS in 10m 06s
✔️ integration-amazon.aws-11 SUCCESS in 8m 26s
✔️ integration-amazon.aws-12 SUCCESS in 6m 28s
✔️ integration-amazon.aws-13 SUCCESS in 7m 53s
✔️ integration-amazon.aws-14 SUCCESS in 9m 40s
Skipped 30 jobs

@alinabuzachis alinabuzachis force-pushed the docs_update_1 branch 3 times, most recently from c4faeed to 36db6fc Compare May 21, 2024 12:31
tremble
tremble approved these changes May 21, 2024
View reviewed changes
plugins/modules/ec2_ami.py Outdated Show resolved Hide resolved
abikouo
abikouo approved these changes May 21, 2024
View reviewed changes
plugins/modules/backup_plan.py Outdated Show resolved Hide resolved
plugins/modules/backup_plan.py Outdated Show resolved Hide resolved
@softwarefactory-project-zuul softwarefactory-project-zuul
Copy link
Contributor

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

✔️ ansible-galaxy-importer SUCCESS in 5m 12s
✔️ build-ansible-collection SUCCESS in 15m 12s
✔️ ansible-test-splitter SUCCESS in 6m 31s
✔️ integration-amazon.aws-1 SUCCESS in 56m 52s
✔️ integration-amazon.aws-2 SUCCESS in 16m 16s
✔️ integration-amazon.aws-3 SUCCESS in 13m 52s
✔️ integration-amazon.aws-4 SUCCESS in 13m 01s
✔️ integration-amazon.aws-5 SUCCESS in 6m 46s
✔️ integration-amazon.aws-6 SUCCESS in 6m 24s
✔️ integration-amazon.aws-7 SUCCESS in 10m 59s
✔️ integration-amazon.aws-8 SUCCESS in 11m 28s
✔️ integration-amazon.aws-9 SUCCESS in 12m 37s
✔️ integration-amazon.aws-10 SUCCESS in 5m 08s
✔️ integration-amazon.aws-11 SUCCESS in 9m 10s
✔️ integration-amazon.aws-12 SUCCESS in 5m 52s
✔️ integration-amazon.aws-13 SUCCESS in 5m 51s
✔️ integration-amazon.aws-14 SUCCESS in 5m 02s
Skipped 30 jobs

@softwarefactory-project-zuul softwarefactory-project-zuul
Copy link
Contributor

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

✔️ ansible-galaxy-importer SUCCESS in 5m 22s
✔️ build-ansible-collection SUCCESS in 16m 50s
✔️ ansible-test-splitter SUCCESS in 6m 08s
✔️ integration-amazon.aws-1 SUCCESS in 36m 19s
✔️ integration-amazon.aws-2 SUCCESS in 16m 31s
✔️ integration-amazon.aws-3 SUCCESS in 8m 30s
✔️ integration-amazon.aws-4 SUCCESS in 8m 41s
✔️ integration-amazon.aws-5 SUCCESS in 6m 20s
✔️ integration-amazon.aws-6 SUCCESS in 7m 48s
✔️ integration-amazon.aws-7 SUCCESS in 7m 26s
✔️ integration-amazon.aws-8 SUCCESS in 6m 39s
✔️ integration-amazon.aws-9 SUCCESS in 14m 23s
✔️ integration-amazon.aws-10 SUCCESS in 6m 14s
✔️ integration-amazon.aws-11 SUCCESS in 12m 20s
✔️ integration-amazon.aws-12 SUCCESS in 6m 30s
✔️ integration-amazon.aws-13 SUCCESS in 7m 14s
✔️ integration-amazon.aws-14 SUCCESS in 9m 59s
Skipped 30 jobs

@tremble tremble added the mergeit Merge the PR (SoftwareFactory) label May 22, 2024
@softwarefactory-project-zuul softwarefactory-project-zuul
Copy link
Contributor

Build failed (gate pipeline). For information on how to proceed, see
http://docs.openstack.org/infra/manual/developers.html#automated-testing

https://ansible.softwarefactory-project.io/zuul/buildset/fa4048acc52840d39ad3d1679e850d21

❌ ansible-galaxy-importer RETRY_LIMIT in 6m 58s
✔️ build-ansible-collection SUCCESS in 15m 29s
✔️ ansible-test-splitter SUCCESS in 6m 09s
✔️ integration-amazon.aws-1 SUCCESS in 36m 08s
✔️ integration-amazon.aws-2 SUCCESS in 20m 01s
✔️ integration-amazon.aws-3 SUCCESS in 7m 21s
❌ integration-amazon.aws-4 RETRY_LIMIT in 1m 43s
✔️ integration-amazon.aws-5 SUCCESS in 5m 19s
✔️ integration-amazon.aws-6 SUCCESS in 10m 37s
✔️ integration-amazon.aws-7 SUCCESS in 9m 51s
✔️ integration-amazon.aws-8 SUCCESS in 9m 10s
✔️ integration-amazon.aws-9 SUCCESS in 18m 18s
✔️ integration-amazon.aws-10 SUCCESS in 8m 49s
✔️ integration-amazon.aws-11 SUCCESS in 9m 25s
✔️ integration-amazon.aws-12 SUCCESS in 5m 31s
✔️ integration-amazon.aws-13 SUCCESS in 7m 28s
✔️ integration-amazon.aws-14 SUCCESS in 5m 37s
Skipped 30 jobs

alinabuzachis and others added 3 commits May 22, 2024 13:56
@alinabuzachis @tremble
Ensures the modules documentation follows the correct formats
0a6e0de 
Signed-off-by: Alina Buzachis <abuzachis@redhat.com>
@alinabuzachis @tremble
Apply suggestions
24be3c3 
Signed-off-by: Alina Buzachis <abuzachis@redhat.com>
@tremble @abikouo
Apply suggestions from code review
dc9fd64 
Co-authored-by: Bikouo Aubin <79859644+abikouo@users.noreply.github.com>
@tremble tremble added mergeit Merge the PR (SoftwareFactory) and removed mergeit Merge the PR (SoftwareFactory) labels May 22, 2024
@softwarefactory-project-zuul softwarefactory-project-zuul
Copy link
Contributor

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

✔️ ansible-galaxy-importer SUCCESS in 7m 50s
✔️ build-ansible-collection SUCCESS in 16m 14s
✔️ ansible-test-splitter SUCCESS in 7m 16s
✔️ integration-amazon.aws-1 SUCCESS in 42m 44s
✔️ integration-amazon.aws-2 SUCCESS in 22m 33s
✔️ integration-amazon.aws-3 SUCCESS in 9m 39s
✔️ integration-amazon.aws-4 SUCCESS in 16m 43s
✔️ integration-amazon.aws-5 SUCCESS in 11m 28s
✔️ integration-amazon.aws-6 SUCCESS in 12m 11s
✔️ integration-amazon.aws-7 SUCCESS in 9m 41s
✔️ integration-amazon.aws-8 SUCCESS in 7m 25s
✔️ integration-amazon.aws-9 SUCCESS in 16m 17s
✔️ integration-amazon.aws-10 SUCCESS in 10m 31s
✔️ integration-amazon.aws-11 SUCCESS in 8m 36s
✔️ integration-amazon.aws-12 SUCCESS in 11m 00s
✔️ integration-amazon.aws-13 SUCCESS in 7m 05s
✔️ integration-amazon.aws-14 SUCCESS in 8m 57s
Skipped 30 jobs

@softwarefactory-project-zuul softwarefactory-project-zuul bot merged commit 574cb86 into ansible-collections:main May 22, 2024
37 of 38 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tremble tremble tremble approved these changes

@abikouo abikouo abikouo approved these changes

Assignees
No one assigned
Labels
mergeit Merge the PR (SoftwareFactory)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@alinabuzachis @tremble @abikouo