From 379bc63e042b1aa8ccae20cd871ed11223928968 Mon Sep 17 00:00:00 2001 From: Don Naro Date: Tue, 28 May 2024 12:18:30 +0100 Subject: [PATCH] Merge pull request #1529 from Andersson007/update_overview_links Requesting a collection: replace overview links (cherry picked from commit fc4087a8bd8570abd744357ba0cb630f164f2b76) --- docs/docsite/rst/community/communication.rst | 8 +++++++- docs/docsite/rst/dev_guide/developing_collections.rst | 2 -- .../rst/dev_guide/developing_collections_creating.rst | 10 +++++----- .../rst/dev_guide/developing_collections_path.rst | 2 +- 4 files changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/docsite/rst/community/communication.rst b/docs/docsite/rst/community/communication.rst index ffb6f3d1ed2..1a0deaf5fe8 100644 --- a/docs/docsite/rst/community/communication.rst +++ b/docs/docsite/rst/community/communication.rst @@ -187,9 +187,15 @@ Anyone can request to start a Working Group, for any reason. If you need only a `Forum group `_, request it in the `forum topic `_. - If you also need a real-time chat channel, you can `request one `_. +.. _request_coll_repo: + +Requesting a community collection repository +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Working groups are often built around Ansible community collections. You can use a repository under your organization or request one under `ansible-collections `_ on the forum by creating a topic in the `Project Discussions category and the coll-repo-request tag `_. + .. _community_topics: Ansible Community Topics diff --git a/docs/docsite/rst/dev_guide/developing_collections.rst b/docs/docsite/rst/dev_guide/developing_collections.rst index b507cd3ef1b..ae8efa7e5ea 100644 --- a/docs/docsite/rst/dev_guide/developing_collections.rst +++ b/docs/docsite/rst/dev_guide/developing_collections.rst @@ -43,8 +43,6 @@ For instructions on developing modules, see :ref:`developing_modules_general`. Learn how to install and use collections in playbooks and roles :ref:`contributing_maintained_collections` Guidelines for contributing to selected collections - `Ansible Collections Overview and FAQ `_ - Current development status of community collections and FAQ `Mailing List `_ The development mailing list :ref:`communication_irc` diff --git a/docs/docsite/rst/dev_guide/developing_collections_creating.rst b/docs/docsite/rst/dev_guide/developing_collections_creating.rst index c2a30b4c9a9..32adfc0765b 100644 --- a/docs/docsite/rst/dev_guide/developing_collections_creating.rst +++ b/docs/docsite/rst/dev_guide/developing_collections_creating.rst @@ -26,23 +26,23 @@ Collection names consist of a namespace and a name, separated by a period (``.`` Usually namespaces and names use lower-case letters, digits, and underscores, but no upper-case letters. -You should make sure that the namespace you use is not registered by someone else by checking on `Ansible Galaxy's namespace list `__. If you chose a namespace or even a full collection name that collides with another collection on Galaxy, it can happen that if you or someone else runs ``ansible-galaxy collection install`` with your collection name, you end up with another collection. Even if the namespace currently does not exist, it could be created later by someone else. +You should make sure that the namespace you use is not registered by someone else by checking on `Ansible Galaxy's namespace list `_. If you chose a namespace or even a full collection name that collides with another collection on Galaxy, it can happen that if you or someone else runs ``ansible-galaxy collection install`` with your collection name, you end up with another collection. Even if the namespace currently does not exist, it could be created later by someone else. -If you want to request a new namespace on Ansible Galaxy, `create an issue on github.com/ansible/galaxy `__. +If you want to request a new namespace on Ansible Galaxy, `create an issue on github.com/ansible/galaxy `_. There are a few special namespaces: :ansible: - The `ansible namespace `__ is owned by Red Hat and reserved for official Ansible collections. Two special members are the synthetic ``ansible.builtin`` and ``ansible.legacy`` collections. These cannot be found on Ansible Galaxy, but are built-in into ansible-core. + The `ansible namespace `_ is owned by Red Hat and reserved for official Ansible collections. Two special members are the synthetic ``ansible.builtin`` and ``ansible.legacy`` collections. These cannot be found on Ansible Galaxy, but are built-in into ansible-core. :community: - The `community namespace `__ is owned by the Ansible community. Collections from this namespace generally live in the `GitHub ansible-collection organization `__. If you want to create a collection in this namespace, it is best to `create an issue in github.com/ansible-collections/overview `__. + The `community namespace `_ is owned by the Ansible community. Collections from this namespace generally live in the `GitHub ansible-collection organization `_. If you want to create a collection in this namespace, :ref:`request` it on the forum. :local: - The `local namespace `__ does not contain any collection on Ansible Galaxy, and the intention is that this will never change. You can use the ``local`` namespace for collections that are locally on your machine or locally in your git repositories, without having to fear collisions with actually existing collections on Ansible Galaxy. + The `local namespace `_ does not contain any collection on Ansible Galaxy, and the intention is that this will never change. You can use the ``local`` namespace for collections that are locally on your machine or locally in your git repositories, without having to fear collisions with actually existing collections on Ansible Galaxy. .. _creating_new_collections: diff --git a/docs/docsite/rst/dev_guide/developing_collections_path.rst b/docs/docsite/rst/dev_guide/developing_collections_path.rst index 2c4d108e070..9f28a639941 100644 --- a/docs/docsite/rst/dev_guide/developing_collections_path.rst +++ b/docs/docsite/rst/dev_guide/developing_collections_path.rst @@ -79,7 +79,7 @@ Publish your collection source code Publish your collection on a platform for software development and version control such as `GitHub `_. It can be your personal repository or your organization's one. -You can also `request `_ a repository under the `ansible-collections `_ organization. +You can also :ref:`request` a repository under the `ansible-collections `_ organization. Make sure your collection contains exhaustive license information. Ansible is an open source project, so we encourage you to license it under one of open source licenses.