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

Document httpapi and cliconf plugins #49503

Merged
merged 4 commits into from
Feb 8, 2019
Merged

Document httpapi and cliconf plugins #49503

merged 4 commits into from
Feb 8, 2019

Conversation

Qalthos
Copy link
Contributor

@Qalthos Qalthos commented Dec 4, 2018

SUMMARY

Some of these plugins have options, and should be documented in the standard way.

Fixes #37292

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

httpapi
cliconf

@Qalthos Qalthos requested a review from samccann December 4, 2018 20:32
@ansibot
Copy link
Contributor

ansibot commented Dec 4, 2018

cc @acozine
click here for bot help

@ansibot ansibot added WIP This issue/PR is a work in progress. Nevertheless it was shared for getting input from peers. affects_2.8 This issue/PR affects Ansible v2.8 docs This issue/PR relates to or includes documentation. docsite This issue/PR relates to the documentation website. needs_triage Needs a first human triage before being processed. new_plugin This PR includes a new plugin. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Dec 4, 2018
@sivel sivel removed needs_triage Needs a first human triage before being processed. labels Dec 4, 2018
@Qalthos Qalthos added networking Network category ci_verified Changes made in this PR are causing tests to fail. labels Dec 4, 2018
@ansibot

This comment has been minimized.

Sign in to view
samccann
samccann reviewed Dec 5, 2018
View reviewed changes
docs/docsite/rst/plugins/cliconf.rst Outdated Show resolved Hide resolved
docs/docsite/rst/plugins/cliconf.rst Outdated Show resolved Hide resolved
docs/docsite/rst/plugins/cliconf.rst Outdated Show resolved Hide resolved
docs/docsite/rst/plugins/cliconf.rst Outdated Show resolved Hide resolved
docs/docsite/rst/plugins/cliconf.rst Outdated Show resolved Hide resolved
docs/docsite/rst/plugins/cliconf.rst Outdated Show resolved Hide resolved
docs/docsite/rst/plugins/cliconf.rst Outdated Show resolved Hide resolved
docs/docsite/rst/plugins/httpapi.rst Outdated Show resolved Hide resolved
docs/docsite/rst/plugins/httpapi.rst Outdated Show resolved Hide resolved
docs/docsite/rst/plugins/httpapi.rst Outdated Show resolved Hide resolved
@ansibot

This comment has been minimized.

Sign in to view
@ansibot
Copy link
Contributor

ansibot commented Dec 5, 2018

cc @acozine
click here for bot help

@ansibot

This comment has been minimized.

Sign in to view
@ansible ansible deleted a comment from ansibot Dec 13, 2018
@ansible ansible deleted a comment from ansibot Dec 13, 2018
@ansible ansible deleted a comment from ansibot Dec 13, 2018
@ansibot ansibot added the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Dec 14, 2018
@Qalthos Qalthos changed the title [WIP] Document httpapi and cliconf plugins Document httpapi and cliconf plugins Feb 5, 2019
@ansibot ansibot added core_review In order to be merged, this PR must follow the core review workflow. and removed WIP This issue/PR is a work in progress. Nevertheless it was shared for getting input from peers. ci_verified Changes made in this PR are causing tests to fail. stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. labels Feb 5, 2019
@ansibot

This comment has been minimized.

Sign in to view
@ansibot ansibot removed the core_review In order to be merged, this PR must follow the core review workflow. label Feb 5, 2019
@ansibot ansibot added the core_review In order to be merged, this PR must follow the core review workflow. label Feb 5, 2019
@Qalthos Qalthos force-pushed the plugin_docs branch 4 times, most recently from 2d003ed to 8e6c216 Compare February 6, 2019 15:29
@ansibot ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed core_review In order to be merged, this PR must follow the core review workflow. labels Feb 6, 2019
@ansibot
Copy link
Contributor

ansibot commented Feb 7, 2019

cc @chrisvanheuveln
click here for bot help

samccann
samccann reviewed Feb 7, 2019
View reviewed changes
Copy link
Contributor

@samccann samccann left a comment

Choose a reason for hiding this comment

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

Seems like a lot, but it's just putting the full network (os) name and capitalization in each of the plugin descriptions (so they match the modules)

lib/ansible/plugins/cliconf/aireos.py Outdated Show resolved Hide resolved
lib/ansible/plugins/cliconf/aireos.py Outdated Show resolved Hide resolved
lib/ansible/plugins/cliconf/aruba.py Outdated Show resolved Hide resolved
lib/ansible/plugins/cliconf/aruba.py Outdated Show resolved Hide resolved
lib/ansible/plugins/cliconf/asa.py Outdated Show resolved Hide resolved
lib/ansible/plugins/cliconf/slxos.py Outdated Show resolved Hide resolved
lib/ansible/plugins/cliconf/slxos.py Outdated Show resolved Hide resolved
lib/ansible/plugins/cliconf/voss.py Outdated Show resolved Hide resolved
lib/ansible/plugins/cliconf/voss.py Outdated Show resolved Hide resolved
lib/ansible/plugins/cliconf/vyos.py Outdated Show resolved Hide resolved
@Qalthos
Copy link
Contributor Author

Qalthos commented Feb 7, 2019

Seems like a lot, but it's just putting the full network (os) name and capitalization in each of the plugin descriptions (so they match the modules)

Yeah, I wasn't entirely sure what most of them were, so I just went for platform name. Thanks!

@samccann @Qalthos
Apply suggestions from code review
25d741d 
Co-Authored-By: Qalthos <this.is@nathanielca.se>
@ansibot ansibot added core_review In order to be merged, this PR must follow the core review workflow. and removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Feb 7, 2019
@Qalthos Qalthos merged commit 7ad238b into ansible:devel Feb 8, 2019
@Qalthos Qalthos deleted the plugin_docs branch February 8, 2019 16:04
@dagwieers dagwieers added asa Cisco ASA community cisco Cisco technologies iosxr Cisco IOSXR community labels Feb 22, 2019
@willthames willthames mentioned this pull request Jun 27, 2019
Closed
@ansible ansible locked and limited conversation to collaborators Jul 25, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@samccann samccann samccann left review comments

Assignees
No one assigned
Labels
affects_2.8 This issue/PR affects Ansible v2.8 asa Cisco ASA community cisco Cisco technologies core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. docsite This issue/PR relates to the documentation website. iosxr Cisco IOSXR community networking Network category new_plugin This PR includes a new plugin. nxos Cisco NXOS community support:community This issue/PR relates to code supported by the Ansible community. support:core This issue/PR relates to code supported by the Ansible Engineering Team. support:network This issue/PR relates to code supported by the Ansible Network Team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Network docs: ANSIBLE_EOS_USE_SESSIONS
5 participants
@Qalthos @ansibot @samccann @sivel @dagwieers