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

Misc doc issues #3572

Merged
merged 5 commits into from
Oct 18, 2021
Merged

Conversation

vitkhab
Copy link
Contributor

@vitkhab vitkhab commented Oct 17, 2021

SUMMARY

Add names to tasks in oneview module examples.
Fix task name in github_webhook module example.

Bring module documentation in line with Ansible doc guide.

Fixes #3353

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

plugins/modules/remote_management/oneview/oneview_datacenter_info.py
plugins/modules/remote_management/oneview/oneview_enclosure_info.py
plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py
plugins/modules/remote_management/oneview/oneview_fc_network_info.py
plugins/modules/remote_management/oneview/oneview_fcoe_network_info.py
plugins/modules/remote_management/oneview/oneview_logical_interconnect_group_info.py
plugins/modules/remote_management/oneview/oneview_network_set_info.py
plugins/modules/remote_management/oneview/oneview_san_manager_info.py
plugins/modules/source_control/github/github_webhook.py

ADDITIONAL INFORMATION

@ansibullbot ansibullbot added WIP Work in progress docs docs_only module module new_contributor Help guide this first time contributor plugins plugin (any type) remote_management source_control labels Oct 17, 2021
@vitkhab vitkhab changed the title [WIP] Misc doc issues Misc doc issues Oct 17, 2021
@vitkhab
Copy link
Contributor Author

vitkhab commented Oct 17, 2021

Ready for review

FYI @Andersson007

@ansibullbot ansibullbot removed the WIP Work in progress label Oct 17, 2021
Copy link
Collaborator

@felixfontein felixfontein left a comment

Choose a reason for hiding this comment

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

Thanks a lot for improving the docs! Looks good (I have only glanced over it though), I have just one small comment.

changelogs/fragments/3572-misc-doc-issues.yml Outdated Show resolved Hide resolved
@felixfontein felixfontein added backport-2 check-before-release PR will be looked at again shortly before release and merged if possible. labels Oct 17, 2021
Copy link
Contributor

@Andersson007 Andersson007 left a comment

Choose a reason for hiding this comment

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

@vitkhab thank for improving the documentation! LGTM

@felixfontein felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Oct 18, 2021
@felixfontein felixfontein merged commit 3731064 into ansible-collections:main Oct 18, 2021
@patchback
Copy link

patchback bot commented Oct 18, 2021

Backport to stable-2: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2/3731064368895e54ad2b47c478bf6227868b3d63/pr-3572

Backported as #3579

🤖 @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 Oct 18, 2021
* Add names to tasks in oneview module examples

* Fix task name in github_webhook module example

* Fix trailing whitespace

* Add changelog fragment

* Remove changelog fragment

(cherry picked from commit 3731064)
@patchback
Copy link

patchback bot commented Oct 18, 2021

Backport to stable-3: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-3/3731064368895e54ad2b47c478bf6227868b3d63/pr-3572

Backported as #3580

🤖 @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 Oct 18, 2021
* Add names to tasks in oneview module examples

* Fix task name in github_webhook module example

* Fix trailing whitespace

* Add changelog fragment

* Remove changelog fragment

(cherry picked from commit 3731064)
@felixfontein
Copy link
Collaborator

@vitkhab thanks for improving the docs!
@Andersson007 thanks for reviewing!

felixfontein pushed a commit that referenced this pull request Oct 18, 2021
* Add names to tasks in oneview module examples

* Fix task name in github_webhook module example

* Fix trailing whitespace

* Add changelog fragment

* Remove changelog fragment

(cherry picked from commit 3731064)

Co-authored-by: Vitaly Khabarov <[email protected]>
felixfontein pushed a commit that referenced this pull request Oct 18, 2021
* Add names to tasks in oneview module examples

* Fix task name in github_webhook module example

* Fix trailing whitespace

* Add changelog fragment

* Remove changelog fragment

(cherry picked from commit 3731064)

Co-authored-by: Vitaly Khabarov <[email protected]>
JonEllis pushed a commit to JonEllis/community.general that referenced this pull request Nov 16, 2021
* Add names to tasks in oneview module examples

* Fix task name in github_webhook module example

* Fix trailing whitespace

* Add changelog fragment

* Remove changelog fragment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs_only docs module module new_contributor Help guide this first time contributor plugins plugin (any type) remote_management source_control
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Misc doc issues
4 participants