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

Improve rule documentation #1831

Closed
ganeshrn opened this issue Jan 25, 2022 · 2 comments
Closed

Improve rule documentation #1831

ganeshrn opened this issue Jan 25, 2022 · 2 comments
Assignees
Labels
AAP Ansible Automation Platform documentation This issue or PR is related to the docs
Milestone

Comments

@ganeshrn
Copy link
Member

Summary

Revisit all the rules from documentation aspects and update the docs to provide a clear and concise explanation for the rules.
If there are issues open for individual rule docs they can tracked using this ticket.

Issue Type
  • Bug Report
Ansible and Ansible Lint details
ansible --version

ansible-lint --version
  • ansible installation method: one of source, pip, OS package
  • ansible-lint installation method: one of source, pip, OS package
OS / ENVIRONMENT
STEPS TO REPRODUCE
Desired Behaviour

Possible security bugs should be reported via email to security@ansible.com

Actual Behaviour

Please give some details of what is actually happening.
Include a minimum complete verifiable example with:

  • playbook
  • output of running ansible-lint
  • if you're getting a stack trace, output of
    ansible-playbook --syntax-check playbook

@ganeshrn ganeshrn added new Triage required documentation This issue or PR is related to the docs AAP Ansible Automation Platform labels Jan 25, 2022
@ssbarnea ssbarnea added this to the 5.4.0 milestone Jan 25, 2022
@relrod relrod removed the new Triage required label Feb 7, 2022
@ssbarnea ssbarnea modified the milestones: 5.4.0, 6.0.0 Feb 12, 2022
@ssbarnea ssbarnea modified the milestones: 6.0.0, 6.8.x Oct 1, 2022
@ssbarnea
Copy link
Member

ssbarnea commented Oct 3, 2022

Just to give an update. We now have >80% of rules with detailed documentation and looking to achieve 100% before end of the month. Is not that the others do not have docs, but is just very brief.

@ssbarnea
Copy link
Member

Closing this as done as at this moment all the rules have documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
AAP Ansible Automation Platform documentation This issue or PR is related to the docs
Projects
Archived in project
Development

No branches or pull requests

4 participants