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

Need offline documentation for Ansible #42303

Closed
Ompragash opened this issue Jul 4, 2018 · 5 comments
Closed

Need offline documentation for Ansible #42303

Ompragash opened this issue Jul 4, 2018 · 5 comments
Labels
affects_2.7 This issue/PR affects Ansible v2.7 feature This issue/PR relates to a feature request. needs_info This issue requires further information. Please answer any outstanding questions. needs_template This issue/PR has an incomplete description. Please fill in the proposed template correctly. support:core This issue/PR relates to code supported by the Ansible Engineering Team.

Comments

@Ompragash
Copy link
Contributor

SUMMARY

Need offline documentation for Ansible.

ISSUE TYPE
  • Feature Idea
ANSIBLE VERSION
Ansible >= 2
@Ompragash Ompragash changed the title Need offline documentation for Ansible Need offline documentation for Ansible Jul 4, 2018
@ansibot
Copy link
Contributor

ansibot commented Jul 4, 2018

@Ompragash Greetings! Thanks for taking the time to open this issue. In order for the community to handle your issue effectively, we need a bit more information.

Here are the items we could not find in your description:

  • component name

Please set the description of this issue with this template:
https://raw.githubusercontent.com/ansible/ansible/devel/.github/ISSUE_TEMPLATE.md

click here for bot help

@ansibot ansibot added affects_2.7 This issue/PR affects Ansible v2.7 feature This issue/PR relates to a feature request. needs_info This issue requires further information. Please answer any outstanding questions. needs_template This issue/PR has an incomplete description. Please fill in the proposed template correctly. needs_triage Needs a first human triage before being processed. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Jul 4, 2018
@gundalow
Copy link
Contributor

gundalow commented Jul 4, 2018

@Ompragash You can do make webdocs in the root of the Ansible checkout to generate this.

@gundalow gundalow removed the needs_triage Needs a first human triage before being processed. label Jul 4, 2018
@gundalow
Copy link
Contributor

gundalow commented Jul 4, 2018

Hi,
I've spoken to some other people to get more info.

We used to create an ansible-docs RPM, though this wasn't ever made available upstream. For various technical and non-technical reasons this has been deprecated.

If you need offline docs, you can build them by doing make webdocs and browsing to docs/docsite/_build/html/ which is how docs.ansible.com/ansible/$VERSION is built.

Therefore I believe this issue can be closed

@gundalow gundalow closed this as completed Jul 4, 2018
@gundalow
Copy link
Contributor

gundalow commented Jul 4, 2018

Also, in case you were not aware you have man pages for the command line tools

As well as ansible-doc for modules and plugins, see https://docs.ansible.com/ansible/latest/cli/ansible-doc.html

@gecube
Copy link

gecube commented Jun 27, 2019

I would like to ask open this issue again, because there is demand in offline documentation about ansible main syntax (like loops, variables, best practices of playbook writing etc.). I did not find any ready rpm/deb or python package realizing this idea. Of course, one can make dump of https://docs.ansible.com/, targz'd it and take the USB flash drive with it's copy, but it does not look like production-ready solution

@ansible ansible locked and limited conversation to collaborators Jul 5, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.7 This issue/PR affects Ansible v2.7 feature This issue/PR relates to a feature request. needs_info This issue requires further information. Please answer any outstanding questions. needs_template This issue/PR has an incomplete description. Please fill in the proposed template correctly. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Development

No branches or pull requests

4 participants