Update collection naming guidelines to galaxy documentation

[IPvSean]

SUMMARY

it is not documented that - dashes will not work in the documentation (here https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#developing-collections)

I get an error like this->

ERROR! Error when publishing collection to release_galaxy (https://galaxy.ansible.com/api/) (HTTP Code: 400, Message: Invalid version string: 'demos-1.0.0' Code: invalid)

However underscores work! It is documented in the galaxy.yml init file! So we should copy that same logic into the documentation

In the galaxy.yml file I see this->

# The namespace of the collection. This can be a company/brand/organization or product namespace under which all
# content lives. May only contain alphanumeric characters and underscores. Additionally namespaces cannot start with
# underscores or numbers and cannot contain consecutive underscores

can we re-use that?

ISSUE TYPE

• Documentation Report

COMPONENT NAME

docs

ANSIBLE VERSION

2.10

CONFIGURATION

OS / ENVIRONMENT

ADDITIONAL INFORMATION

[ansibot]

Files identified in the description:
None

If these files are incorrect, please update the component name section of the description or use the !component bot command.

click here for bot help

[ansibot]

@IPvSean: Greetings! Thanks for taking the time to open this issue. In order for the community to handle your issue effectively, we need a bit more information.

Here are the items we could not find in your description:

• component name

Please set the description of this issue with this template:
https://raw.githubusercontent.com/ansible/ansible/devel/.github/ISSUE_TEMPLATE/bug_report.md

click here for bot help

[jborean93]

Just an FYI we do not have the ability to modify the error message from ansible-galaxy publish as that’s what is returned from the Galaxy instance. If you wanted to make that a bit more obvious you need to raise the issue there.

[IPvSean]

LOL just got told to move this ticket here by house...

…

On Sat, Apr 25, 2020 at 6:23 PM Jordan Borean ***@***.***> wrote: Just an FYI we do not have the ability to modify the error message from ansible-galaxy publish as that’s what is returned from the Galaxy instance. If you wanted to make that a bit more obvious you need to raise the issue there. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#69171 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABR4DUAZ5G2Y2CU4WK3MHJLRONPG7ANCNFSM4MQXHQGA> .

[jborean93]

If you want to update the docs at https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#developing-collections then we can do that. As you’ve seen we already have some info on this on the templated galaxy.yml file.

If you want the error message from ansible-galaxy publish to have this information then we can’t. We just output the error code and message from what the API returns. Because that’s where all the validation occurs and we don’t want to duplicate efforts especially since the endpoint should be the source of truth for the validation.

[sivel]

bot_status

[ansibot]

Files identified in the description:

• docs/docsite/README.md

If these files are incorrect, please update the component name section of the description or use the !component bot command.

click here for bot help

[ansibot]

Components

docs/docsite/README.md
support: core
maintainers: acozine

Metadata

waiting_on: maintainer
needs_info: False

click here for bot help

[samccann]

We added a note in the docs to point to the namespace etc limitations documentation - https://docs.ansible.com/ansible/2.10/dev_guide/developing_collections.html#creating-a-collection-skeleton