Panos/doc fragment #37696
Merged
Panos/doc fragment #37696
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ansibot
added
core_review
|
The test The test The test The test The test The test The test The test The test |
ansibot
added
ci_verified
samdoran
removed
the
needs_triage
acozine
moved this from Docsite work
to Module docs maintenance
in Ansible-maintained Collections Documentation
acozine
moved this from Module docs maintenance
to In progress
in Ansible-maintained Collections Documentation
ansibot
added
the
stale_ci
|
What is needed for this to be merged? |
acozine
moved this from In progress
to Community Modules Maintenance
in Ansible-maintained Collections Documentation
ansibot
added
needs_rebase
|
Can you please rebase then I'll look at getting this merged. thanks |
gundalow
reviewed
May 2, 2018
| options: | ||
| ip_address: | ||
| description: | ||
| - IP address (or hostname) of PAN-OS device |
There was a problem hiding this comment.
Could you add a fullstop at the end of this (and other)
| required: true | ||
| password: | ||
| description: | ||
| - password for authentication |
| required: true | ||
| username: | ||
| description: | ||
| - username for authentication |
ansibot
removed
the
stale_ci
- Module documentation fragment currently holds 3 parameters - It most likely won't be used in every single module since there is some variance
- Where documentation is consistent, module documentation now uses a documentation fragment instead of all documentation being contained in the module.
Updated some formatting errors to make ansibot happy.
ansibot
added
core_review
gundalow
approved these changes
May 9, 2018
|
Thank you for contributing to cleaner documentation! |
Ansible-maintained Collections Documentation
automation
moved this from Community Modules Maintenance
to Done
May 9, 2018
oolongbrothers
pushed a commit
to oolongbrothers/ansible
that referenced
this pull request
May 12, 2018
* Create PanOS module documentation fragment - Module documentation fragment currently holds 3 parameters - It most likely won't be used in every single module since there is some variance * Modified PanOS module for use doc_frags - Where documentation is consistent, module documentation now uses a documentation fragment instead of all documentation being contained in the module. * Formatting and syntax error fixes Updated some formatting errors to make ansibot happy. * Revisions for grammar
oolongbrothers
pushed a commit
to oolongbrothers/ansible
that referenced
this pull request
May 14, 2018
* Create PanOS module documentation fragment - Module documentation fragment currently holds 3 parameters - It most likely won't be used in every single module since there is some variance * Modified PanOS module for use doc_frags - Where documentation is consistent, module documentation now uses a documentation fragment instead of all documentation being contained in the module. * Formatting and syntax error fixes Updated some formatting errors to make ansibot happy. * Revisions for grammar
oolongbrothers
pushed a commit
to oolongbrothers/ansible
that referenced
this pull request
May 14, 2018
* Create PanOS module documentation fragment - Module documentation fragment currently holds 3 parameters - It most likely won't be used in every single module since there is some variance * Modified PanOS module for use doc_frags - Where documentation is consistent, module documentation now uses a documentation fragment instead of all documentation being contained in the module. * Formatting and syntax error fixes Updated some formatting errors to make ansibot happy. * Revisions for grammar
tonal
pushed a commit
to tonal/ansible
that referenced
this pull request
May 15, 2018
* Create PanOS module documentation fragment - Module documentation fragment currently holds 3 parameters - It most likely won't be used in every single module since there is some variance * Modified PanOS module for use doc_frags - Where documentation is consistent, module documentation now uses a documentation fragment instead of all documentation being contained in the module. * Formatting and syntax error fixes Updated some formatting errors to make ansibot happy. * Revisions for grammar
oolongbrothers
pushed a commit
to oolongbrothers/ansible
that referenced
this pull request
May 15, 2018
* Create PanOS module documentation fragment - Module documentation fragment currently holds 3 parameters - It most likely won't be used in every single module since there is some variance * Modified PanOS module for use doc_frags - Where documentation is consistent, module documentation now uses a documentation fragment instead of all documentation being contained in the module. * Formatting and syntax error fixes Updated some formatting errors to make ansibot happy. * Revisions for grammar
oolongbrothers
pushed a commit
to oolongbrothers/ansible
that referenced
this pull request
May 15, 2018
* Create PanOS module documentation fragment - Module documentation fragment currently holds 3 parameters - It most likely won't be used in every single module since there is some variance * Modified PanOS module for use doc_frags - Where documentation is consistent, module documentation now uses a documentation fragment instead of all documentation being contained in the module. * Formatting and syntax error fixes Updated some formatting errors to make ansibot happy. * Revisions for grammar
ilicmilan
pushed a commit
to ilicmilan/ansible
that referenced
this pull request
Nov 7, 2018
* Create PanOS module documentation fragment - Module documentation fragment currently holds 3 parameters - It most likely won't be used in every single module since there is some variance * Modified PanOS module for use doc_frags - Where documentation is consistent, module documentation now uses a documentation fragment instead of all documentation being contained in the module. * Formatting and syntax error fixes Updated some formatting errors to make ansibot happy. * Revisions for grammar
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
Many of the PanOS modules have duplicate documentation. This pull request’s goal is to summarize documentation, where possible, in a documentation fragment instead of in the module itself.
ISSUE TYPE
COMPONENT NAME
panos_admin
This affects other modules as well
ANSIBLE VERSION
ADDITIONAL INFORMATION
Not all modules are affected by this change. If a documentation fragment should exist only when all modules in a family can use it, it likely makes sense to cancel this PR.