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

ansible-examples should adhere to the standards of the ansible-linter #322

Open
RayJin2000 opened this issue Mar 15, 2024 · 0 comments
Open

Comments

@RayJin2000
Copy link

I believe that Ansible examples should adhere to the standards of the Ansible linter.

Arguments in favor:

  • Consistency and maintainability: Linting ensures that examples are consistent in style and formatting, which makes them easier to read and maintain.
  • Readability: Linting can help to improve the readability of examples by identifying and fixing common errors, such as missing indentation or incorrect syntax.
  • Accuracy: Linting can help to ensure that examples are accurate and up-to-date by identifying and fixing errors in the code.

Benefits:

  • Improved user experience: Users will have a better experience when using Ansible examples if they are consistent, readable, and accurate.
  • Reduced errors: Linting can help to reduce the number of errors in Ansible examples, which will improve the quality of the documentation.
  • Increased confidence: Users will have more confidence in Ansible examples if they know that they have been linted and are therefore more likely to be accurate.

Conclusion:

I believe that the benefits of linting Ansible examples outweigh the costs. I encourage the Ansible community to adopt a linting standard for examples and to lint all examples before they are published.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant