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 #3353

Closed
1 task done
Andersson007 opened this issue Sep 9, 2021 · 1 comment · Fixed by #3572
Closed
1 task done

Misc doc issues #3353

Andersson007 opened this issue Sep 9, 2021 · 1 comment · Fixed by #3572
Labels
docs easyfix Good for new comers and easy to start with contribution module module net_tools waiting_on_contributor Needs help. Feel free to engage to get things unblocked

Comments

@Andersson007
Copy link
Contributor

Andersson007 commented Sep 9, 2021

Summary

Suits for the first contribution. Use this Quick-start guide to learn how to submit your first PR

  1. Use - name: with the tasks in EXAMPLES block in plugins/modules/remote_management/oneview/oneview_fcoe_network_info.py.
    For example
 64 - ansible.builtin.debug:
 65   msg: "{{ result.fcoe_networks }}"

should be changed to something like

 64 - name: Print fetched information
 65   ansible.builtin.debug:
 66     msg: "{{ result.fcoe_networks }}"

This is the Ansible doc guide requirement.

  1. Same as the above but for plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py

  2. Same as the above but for plugins/modules/remote_management/oneview/oneview_network_set_info.py

  3. Other files under plugins/modules/remote_management/oneview/.

  4. One of examples in plugins/modules/source_control/github/github_webhook.py does not start with a capital letter which is required by the doc guide.

Issue Type

Documentation Report

Component Name

plugins/modules/source_control/github/github_webhook.py
plugins/modules/remote_management/oneview/oneview_fcoe_network_info.py
plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py
plugins/modules/remote_management/oneview/oneview_network_set_info.py

Code of Conduct

  • I agree to follow the Ansible Code of Conduct
@Andersson007 Andersson007 added docs easyfix Good for new comers and easy to start with contribution labels Sep 9, 2021
@Andersson007
Copy link
Contributor Author

bot_skip

@Andersson007 Andersson007 changed the title For the hackathon: Align examples in nios_txt_record module For the hackathon: misc doc issues Sep 9, 2021
@Andersson007 Andersson007 changed the title For the hackathon: misc doc issues Misc doc issues Oct 8, 2021
@Andersson007 Andersson007 added the waiting_on_contributor Needs help. Feel free to engage to get things unblocked label Oct 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs easyfix Good for new comers and easy to start with contribution module module net_tools waiting_on_contributor Needs help. Feel free to engage to get things unblocked
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants