# Does galaxy-importer need its own documentation? **URL:** \ **Category:** Project Discussions\ **Tags:** documentation, ansible-lint, galaxy-ng\ **Created:** [April 16, 2024, 4:15pm UTC](https://forum.ansible.com/t/does-galaxy-importer-need-its-own-documentation/4979 "2024-04-16T16:15:36Z")\ **Posts on this page:** 6\ **Page:** 1
**Author:** ![samccann](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/samccann/32/18_2.png) [@samccann](https://forum.ansible.com/u/samccann)\ **Post date:** [April 16, 2024, 4:15pm UTC](https://forum.ansible.com/t/does-galaxy-importer-need-its-own-documentation/4979/1 "2024-04-16T16:15:36Z")
This is related to [Ansible-galaxy lint unexpected warnings - #6 by allhart](http://forum.ansible.com/t/ansible-galaxy-lint-unexpected-warnings/3825/6) and [Update to Roles Documentation main.yml Minimum Requirements · Issue #1262 · ansible/ansible-documentation · GitHub](https://github.com/ansible/ansible-documentation/issues/1262). What I’m seeing is that `galaxy-importer` is tied to one version of `ansible-lint` (potentially moving to 6.22.x), but the [ansible-lint documentation](https://ansible.readthedocs.io/projects/lint/) is only for its most recent release (currently 24.2.2). The big number jump is a move to CalVer but the basic point is community folks (and potentially Automation Hub collection owners) have difficulties knowing which version of ansible-lint to run locally to align with `galaxy-importer`. And occasionally `ansible-lint` makes changes that mean a [rule is gone entirely,](https://github.com/ansible/ansible-lint/pull/3267) but a user may be running something that requires this older `ansible-lint` version and can’t find any details. Note: galaxy-importer documentation could just mean updating the current readme with a bit more detail, but that still leaves difficulties when `ansible-lint` makes changes like the one above and users are lost when they hit it and can’t find any docs for this older version that is in use in galaxy-land. (@allhart @ssbarnea as involved in recent discussions on this). ---
**Author:** ![allhart](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/allhart/32/9400_2.png) [@allhart](https://forum.ansible.com/u/allhart)\ **Post date:** [April 30, 2024, 1:10pm UTC](https://forum.ansible.com/t/does-galaxy-importer-need-its-own-documentation/4979/2 "2024-04-30T13:10:16Z")
I can input on the galaxy-importer side: Totally agree: galaxy-importer could use more documentation on requirements and dependencies. This could be an expansion to the importer README with a “Requirements” section? ---
**Author:** ![samccann](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/samccann/32/18_2.png) [@samccann](https://forum.ansible.com/u/samccann)\ **Post date:** [May 2, 2024, 2:05pm UTC](https://forum.ansible.com/t/does-galaxy-importer-need-its-own-documentation/4979/3 "2024-05-02T14:05:07Z")
Yes that would be helpful for sure. With Ansible-lint docs only publishing latest release, maybe add a link to the GitHub branch docs folder that matches the Ansible-lint version used? ---
**Author:** ![samccann](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/samccann/32/18_2.png) [@samccann](https://forum.ansible.com/u/samccann)\ **Post date:** [May 7, 2024, 1:59pm UTC](https://forum.ansible.com/t/does-galaxy-importer-need-its-own-documentation/4979/4 "2024-05-07T13:59:52Z")
Related to this, and I’m not sure where the documentation should be, but the old galaxy docs used to talk about the [role metadata requirements](https://old-galaxy.ansible.com/docs/contributing/creating_role.html#role-metadata) and that doesn’t exist anymore in the new galaxy docs. Does this feel like a gap in the galaxy docs or galaxy-importer @allhart ? I’m struggling on where a user should go to understand these requirements (other than digging through failed `ansible-lint` results… ---
**Author:** ![samccann](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/samccann/32/18_2.png) [@samccann](https://forum.ansible.com/u/samccann)\ **Post date:** [May 8, 2024, 2:58pm UTC](https://forum.ansible.com/t/does-galaxy-importer-need-its-own-documentation/4979/5 "2024-05-08T14:58:12Z")
Also related is another role creator asking for details on this - [Galaxy API URL for listing supported platforms](http://forum.ansible.com/t/galaxy-api-url-for-listing-supported-platforms/5613) ---
**Author:** ![allhart](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/allhart/32/9400_2.png) [@allhart](https://forum.ansible.com/u/allhart)\ **Post date:** [May 9, 2024, 3:45pm UTC](https://forum.ansible.com/t/does-galaxy-importer-need-its-own-documentation/4979/6 "2024-05-09T15:45:15Z")
That seems to me like it should go in the galaxy docs rather than only in importer, but I think we should link to that documentation in the importer docs.