docs: ansible-lint is not a molecule dep #3446
Conversation
|
A few notes: The changes in setup.cfg and the init command are the important ones. The setup.cfg comment is the one that led me to believe The rest of the changes below I would consider 'optional', and am happy to remove any or all of them. in docs/configuration.rst I changed 'is' to 'was' to clarify that this code is not literally reused from ansible-lint in the sense that it's a dependency, but rather that it was copied For the docs, I updated in the 3 places I thought most relevant:
|
docs/installation.rst
Outdated
|
|
||
| .. code-block:: bash | ||
| $ python3 -m pip install --user "molecule[lint] ansible-lint" |
There was a problem hiding this comment.
Remove lint extra from here, it is used only internally.
There was a problem hiding this comment.
Ahh... maybe this is where all of the confusion originally stems from? The current documentation instructs users to install via:
$ python3 -m pip install --user "molecule[lint]"If I understand correctly, molecule[lint] shouldn't be referenced in the user documentation at all. Is this correct? If so, I'll double check that there are no other references to it in the user docs and fix them all in this PR.
There was a problem hiding this comment.
You are right, that's mostly for internal use. There are no direct imports from molecule itself to any stuff inside lint exta.
| * The :ref:`lint` command. Molecule can call external commands to ensure | ||
| that best practices are encouraged. | ||
| that best practices are encouraged. Note: `ansible-lint` is not included with | ||
| molecule or molecule[lint]. |
resolves #3445