How to get our collection doc added into the collection index section?

Get Help
,
1

Please replace this text with a description of your issue. You should:

Hi All! I’m a maintainer of the ibm_zos_core collection (GitHub - ansible-collections/ibm_zos_core: Red Hat Ansible Certified Content for IBM Z) we’ve been releasing content to Galaxy and Automation Platform for about 5 years now.

Now we are looking to get our documentation added into the collection index section (Collection Index — Ansible Community Documentation), I found this ansible-inclusion (GitHub - ansible-collections/ansible-inclusion: Requests to include new collections into the ansible package) repo but seems to be for a collection to get included into the community package which is not what I’m looking for at the moment. At this point I just want our collection docs to be added into the collection index section. Is there a guide to do that?

- my code!
  • Set at least one tag (the experts follow the tags, so the right people will find you if you tag)
2

Hi @fernandofloresg -

The collections on docs.ansible.com are only for collections within the Ansible community package.

Certified collections are documented on Red Hat’s Software Catalog. You can see your collection here.

3

So that means that if I want my collection to appear in docs.ansible.com I need to follow the ansible inclusion process right?

4

yes, that is correct

1 Like
5

I’m not sure if it’s a good idea to add this collection to the Ansible Community Package only to make the documentation show up on docs.ansible.com. ATM it feels like we have a lot of problems with collections that wanted to be part of the ACP for whatever reasons, but don’t really follow our rules…

On the other hand, if you want your collection to be added to ACP and are fine with our ollections requirements: Feel free to ask about inclusion to ACP.

Maybe we should make it clearer that the collection index is only about collections included in the Ansible Community Package? I think we don’t state this explicitly just now.

Another idea, since it looks like this collection is RH certified: Have a Certified Collections index on docs.ansible.com.

@fernandofloresg Do you have any additional documentation in your collection to show up? If not, tell your users to look it up on galaxy. I think it’s even easier to find the documentation on the version you’re using there than anywhere else.

That is, if you don’t rely on code and documentation from other collections. Look here why this isn’t easy, or even impossible.

1 Like
6

Thanks @mariolenz. We do have a dedicated docs site for our collection, I was just exploring the possibility of having it in ansible.com too, but if that is reserved for ACP that’s ok. We don’t have intention for it to be added into ACP at the moment.

Having a Certified Collections index looks like a good idea, our intention was to have extra visibility from users exploring ansible.com docs.

2 Likes