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

Missing documentation for lookup plugin dig #13126

Closed
azaghal opened this issue Nov 11, 2015 · 7 comments
Closed

Missing documentation for lookup plugin dig #13126

azaghal opened this issue Nov 11, 2015 · 7 comments
Labels
docs This issue/PR relates to or includes documentation.

Comments

@azaghal
Copy link
Contributor

azaghal commented Nov 11, 2015

Issue Type: Documentation Report
Ansible Version: 1.9.4
Ansible Configuration: N/A
Environment: Debian Jessie (N/A?)

Summary:

Lookup plugin dig is not documented on the http://docs.ansible.com/ansible/playbooks_lookups.html page.

Expected results:

Lookup plugin dig is documented.

Actual results:

Lookup plugin dig is not documented.

@azaghal azaghal changed the title Missing documentation for certain lookup plugins Missing documentation lookup plugin **dig** Nov 11, 2015
@azaghal azaghal changed the title Missing documentation lookup plugin **dig** Missing documentation lookup plugin dig Nov 11, 2015
@azaghal azaghal changed the title Missing documentation lookup plugin dig Missing documentation for lookup plugin dig Nov 11, 2015
@azaghal
Copy link
Contributor Author

azaghal commented Nov 11, 2015

This is probably a very easy thing to provide - unless someone beats me to it, I'll try to submit a pull request.

@chrrrles
Copy link
Contributor

Hi azaghai - Documentation for this plugin is welcome. Were you planning on creating a new section, or adding it to the "More Lookups" part of the page?

cc'ing @docschick

@bcoca
Copy link
Member

bcoca commented Nov 11, 2015

we are also thinking of 'autodocumenting' all plugins like we currently do with modules, so lookup, filter, connection, etc should all get documented and appear in the site once added. But this is still in the planning stage so go ahead and submit the docs as we'll need them for the plugin anyways.

@azaghal
Copy link
Contributor Author

azaghal commented Nov 11, 2015

I'm not sure, to be honest, but it feels like it would be better to have a new section with less frequently uses lookups. Another choice could be to have more of a dedicated reference-like section for plugins in general, and perhaps this could be a start of it (i.e. introduce a couple of lookups in practical examples, and move rest to this separate section)?

But, in the end, whatever you would prefer as location :)

@azaghal
Copy link
Contributor Author

azaghal commented Nov 11, 2015

Given @bcoca 's comment - perhaps for now I can add it in same part of docs as where the rest of lookups are mentioned? Although this one is a bit more complex, I think.

azaghal added a commit to azaghal/ansible that referenced this issue Dec 20, 2015
bcoca added a commit that referenced this issue Dec 21, 2015
…tation

Adding documentation for the 'dig' lookup (#13126).
@mscherer
Copy link
Contributor

So, can this bug be closed, since the patch was merged ?

@docschick
Copy link

Closing based on merges for missing docs.

@ansibot ansibot added docs This issue/PR relates to or includes documentation. and removed docs_report labels Mar 1, 2018
@ansible ansible locked and limited conversation to collaborators Apr 25, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs This issue/PR relates to or includes documentation.
Projects
None yet
Development

No branches or pull requests

6 participants