ansible-examples
ansible-examples copied to clipboard
ansible-examples should adhere to the standards of the ansible-linter
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.