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

Docs cheatsheet - skeleton and ansible-playbook #76655

Merged
merged 6 commits into from Mar 31, 2022

Conversation

acozine
Copy link
Contributor

@acozine acozine commented Jan 5, 2022

SUMMARY

Starts to address ansible/ansible-documentation#48.

Starting with a skeleton page - a header and a first example. I'll add a list of CLI commands to the issue so the community can help create this content. We should certainly cover the most commonly-used CLI commands.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

docs.ansible.com

ADDITIONAL INFORMATION

N/A

@ansibot ansibot added WIP This issue/PR is a work in progress. Nevertheless it was shared for getting input from peers. affects_2.13 docs This issue/PR relates to or includes documentation. docs_only All changes are to files within the docs/docsite/ directory 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 Jan 5, 2022
@acozine acozine marked this pull request as draft January 5, 2022 15:51
@ansibot
Copy link
Contributor

ansibot commented Jan 5, 2022

The test ansible-test sanity --test docs-build [explain] failed with 1 error:

docs/docsite/rst/user_guide/cheatsheet.rst:0:0: not-in-toc-tree: document isn't included in any toctree

click here for bot help

@ansibot ansibot added the ci_verified Changes made in this PR are causing tests to fail. label Jan 5, 2022
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.

This is a great start, thanks!

docs/docsite/rst/user_guide/cheatsheet.rst Outdated Show resolved Hide resolved
@bcoca bcoca removed the needs_triage Needs a first human triage before being processed. label Jan 11, 2022
@acozine acozine mentioned this pull request Jan 18, 2022
1 task
@ansibot ansibot added has_issue 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 Jan 18, 2022
@ansibot
Copy link
Contributor

ansibot commented Mar 26, 2022

Thanks for your Ansible docs contribution! We talk about Ansible documentation on maxtrix at #docs:ansible.im and on libera IRC at #ansible-docs if you ever want to join us and chat about the docs! We meet there on Tuesdays (see the Ansible calendar) and welcome additions to our weekly agenda items - scroll down to find the upcoming agenda and add a comment to put something new on that agenda.

click here for bot help

Co-authored-by: Sandra McCann <samccann@redhat.com>
@ansibot ansibot added ci_verified Changes made in this PR are causing tests to fail. and removed 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 Mar 29, 2022
@ansibot ansibot added ci_verified Changes made in this PR are causing tests to fail. and removed ci_verified Changes made in this PR are causing tests to fail. labels Mar 29, 2022
@acozine acozine marked this pull request as ready for review March 29, 2022 16:09
@ansibot ansibot removed the ci_verified Changes made in this PR are causing tests to fail. label Mar 29, 2022
@acozine acozine changed the title WIP: Docs cheatsheet Docs cheatsheet - skeleton and ansible-playbook Mar 30, 2022
@ansibot ansibot removed the WIP This issue/PR is a work in progress. Nevertheless it was shared for getting input from peers. label Mar 30, 2022
@ansibot ansibot added the core_review In order to be merged, this PR must follow the core review workflow. label Mar 30, 2022
@samccann samccann merged commit 21addac into ansible:devel Mar 31, 2022
samccann pushed a commit to samccann/ansible that referenced this pull request Mar 31, 2022
sivel pushed a commit that referenced this pull request Apr 5, 2022
* add links.yml to collection structure docs (#77415)

* add links.yml to collection structure docs
* fix link
* Update docs/docsite/rst/dev_guide/developing_collections_structure.rst

(cherry picked from commit 8caa6ef)

* Example is a single play, not a playbook

(cherry picked from commit bf8e186)

* Fix list formatting (#77354)

(cherry picked from commit e918cfa)

* Most Matrix channels are ansible.com and not .im (#77352)

(cherry picked from commit 6557a60)

* Docs cheatsheet - skeleton and ansible-playbook (#76655)

(cherry picked from commit 21addac)

Co-authored-by: rwhector <richard@walnut.gen.nz>
Co-authored-by: Christian Adamini <christian.adamini@invision.de>
Co-authored-by: bluikko <14869000+bluikko@users.noreply.github.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
@ansible ansible locked and limited conversation to collaborators Apr 7, 2022
@acozine acozine deleted the docs_cheatsheet branch May 16, 2023 15:37
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.13 core_review In order to be merged, this PR must follow the core review workflow. docs_only All changes are to files within the docs/docsite/ directory docs This issue/PR relates to or includes documentation. has_issue support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants