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

[WIP] Document httpapi and cliconf plugins #49503

Open
wants to merge 8 commits into
base: devel
from

Conversation

Projects
None yet
4 participants
@Qalthos
Contributor

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 Dec 4, 2018

@ansibot

This comment has been minimized.

Contributor

ansibot commented Dec 4, 2018

@Qalthos Qalthos added the networking label Dec 4, 2018

@Qalthos Qalthos added the ci_verified label Dec 5, 2018

@ansibot

This comment was marked as outdated.

Contributor

ansibot commented Dec 5, 2018

The test ansible-test sanity --test docs-build [explain] failed with 2 errors:

docs/docsite/rst/plugins/cliconf.rst:44:0: toc-tree-glob-pattern-no-match: toctree glob pattern 'cliconf/*' didn't match any documents
docs/docsite/rst/plugins/httpapi.rst:44:0: toc-tree-glob-pattern-no-match: toctree glob pattern 'httpapi/*' didn't match any documents

click here for bot help

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
.. _cliconf_plugin_list:
Plugin List

This comment has been minimized.

@samccann

samccann Dec 5, 2018

Contributor
Suggested change Beta
Plugin List
Plugin list

This comment has been minimized.

@Qalthos

Qalthos Dec 5, 2018

Contributor

Pretty sure this should still be title case. In any case, this is how it is in all other pages

This comment has been minimized.

@samccann

samccann Dec 5, 2018

Contributor

not a biggie. We're slowly moving to sentence case so I comment as I notice it in reviews...

Show resolved Hide resolved docs/docsite/rst/plugins/httpapi.rst Outdated
device.
Each plugin represents a particular dialect of API. Some are platform-specific (eos, nxos), while others
might be usable on a variety of platforms (restconf).

This comment has been minimized.

@samccann

samccann Dec 5, 2018

Contributor

Not sure which way you want to show this. Either it should be Arista EOS, Cisco NX-OS..and RESTCONF... or put them as eos etc so it's obvious they are settings.

Show resolved Hide resolved docs/docsite/rst/plugins/httpapi.rst Outdated

samccann and others added some commits Dec 5, 2018

Update docs/docsite/rst/plugins/cliconf.rst
Co-Authored-By: Qalthos <this.is@nathanielca.se>
Update docs/docsite/rst/plugins/cliconf.rst
Co-Authored-By: Qalthos <this.is@nathanielca.se>
Apply suggestions from code review
Co-Authored-By: Qalthos <this.is@nathanielca.se>
@ansibot

This comment has been minimized.

Contributor

ansibot commented Dec 5, 2018

The test ansible-test sanity --test docs-build [explain] failed with 2 errors:

docs/docsite/rst/plugins/cliconf.rst:44:0: toc-tree-glob-pattern-no-match: toctree glob pattern 'cliconf/*' didn't match any documents
docs/docsite/rst/plugins/httpapi.rst:44:0: toc-tree-glob-pattern-no-match: toctree glob pattern 'httpapi/*' didn't match any documents

click here for bot help

@ansibot

This comment has been minimized.

Contributor

ansibot commented Dec 5, 2018

@ansibot

This comment has been minimized.

Contributor

ansibot commented Dec 12, 2018

The test ansible-test sanity --test docs-build [explain] failed with 2 errors:

docs/docsite/rst/plugins/cliconf.rst:44:0: toc-tree-glob-pattern-no-match: toctree glob pattern 'cliconf/*' didn't match any documents
docs/docsite/rst/plugins/httpapi.rst:44:0: toc-tree-glob-pattern-no-match: toctree glob pattern 'httpapi/*' didn't match any documents

click here for bot help

@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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment