From e03527e7227b1358503f11a053ac88640d44181c Mon Sep 17 00:00:00 2001 From: Sandra McCann Date: Fri, 19 Aug 2022 13:16:48 -0400 Subject: [PATCH] Backportapalooza 08 11 (#78526) * update the documentation for the _collection init_ command (#78404) (cherry picked from commit 69c7e3f4a3e244b28eef919ff2c1356ea6d06b1c) * fix configuration name in porting guide 2.12 (#78472) (cherry picked from commit 82246df5b7fb10aa464d65e3f948514c85c05757) * docs: misc fixes in The Ansible Development Cycle (#78513) (cherry picked from commit 0d3523df8ff6b60d98804af4f1898a341776c756) Co-authored-by: Alex Co-authored-by: Akira Yokochi --- docs/docsite/rst/community/development_process.rst | 4 ++-- .../rst/dev_guide/developing_collections_creating.rst | 6 ++++-- docs/docsite/rst/porting_guides/porting_guide_5.rst | 2 +- docs/docsite/rst/porting_guides/porting_guide_core_2.12.rst | 2 +- 4 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/docsite/rst/community/development_process.rst b/docs/docsite/rst/community/development_process.rst index 4fbf7c8b77b..344e07395db 100644 --- a/docs/docsite/rst/community/development_process.rst +++ b/docs/docsite/rst/community/development_process.rst @@ -45,7 +45,7 @@ Here's an overview of the PR lifecycle: * Contributor addresses any feedback from reviewers * Developers, maintainers, community re-review * PR merged or closed -* PR `backported `_ to one or more ``stable-X.Y`` branches (optional, bugfixes only) +* PR :ref:`backported ` to one or more ``stable-X.Y`` branches (optional, bugfixes only) Automated PR review: ansibullbot -------------------------------- @@ -369,7 +369,7 @@ We do **not** backport features. .. code-block:: shell git fetch upstream - git checkout -b backport/2.12/[PR_NUMBER_FROM_DEVEL] upstream/stable-2.13 + git checkout -b backport/2.13/[PR_NUMBER_FROM_DEVEL] upstream/stable-2.13 #. Cherry pick the relevant commit SHA from the devel branch into your feature branch, handling merge conflicts as necessary: diff --git a/docs/docsite/rst/dev_guide/developing_collections_creating.rst b/docs/docsite/rst/dev_guide/developing_collections_creating.rst index ae20c68f7b0..2e8de1c4044 100644 --- a/docs/docsite/rst/dev_guide/developing_collections_creating.rst +++ b/docs/docsite/rst/dev_guide/developing_collections_creating.rst @@ -22,16 +22,18 @@ A user can then install your collection on their systems. Creating a collection skeleton ============================== -To start a new collection: +To start a new collection, run the following command in your collections directory: .. code-block:: bash - collection_dir#> ansible-galaxy collection init my_namespace.my_collection + ansible_collections#> ansible-galaxy collection init my_namespace.my_collection .. note:: Both the namespace and collection names use the same strict set of requirements. See `Galaxy namespaces `_ on the Galaxy docsite for those requirements. +It will create the structure ``[my_namespace]/[my_collection]/[collection skeleton]``. +.. hint:: If Git is used for version control, the corresponding repository should be initialized in the collection directory. Once the skeleton exists, you can populate the directories with the content you want inside the collection. See `ansible-collections `_ GitHub Org to get a better idea of what you can place inside a collection. Reference: the ``ansible-galaxy collection`` command diff --git a/docs/docsite/rst/porting_guides/porting_guide_5.rst b/docs/docsite/rst/porting_guides/porting_guide_5.rst index b02bfc83127..d3ba694e8f3 100644 --- a/docs/docsite/rst/porting_guides/porting_guide_5.rst +++ b/docs/docsite/rst/porting_guides/porting_guide_5.rst @@ -46,7 +46,7 @@ Playbook Python Interpreter Discovery ============================ -The default value of ``INTERPRETER_PYTHON_FALLBACK`` changed to ``auto``. The list of Python interpreters in ``INTERPRETER_PYTHON_FALLBACK`` changed to prefer Python 3 over Python 2. The combination of these two changes means the new default behavior is to quietly prefer Python 3 over Python 2 on remote hosts. Previously a deprecation warning was issued in situations where interpreter discovery would have used Python 3 but the interpreter was set to ``/usr/bin/python``. +The default value of ``INTERPRETER_PYTHON`` changed to ``auto``. The list of Python interpreters in ``INTERPRETER_PYTHON_FALLBACK`` changed to prefer Python 3 over Python 2. The combination of these two changes means the new default behavior is to quietly prefer Python 3 over Python 2 on remote hosts. Previously a deprecation warning was issued in situations where interpreter discovery would have used Python 3 but the interpreter was set to ``/usr/bin/python``. ``INTERPRETER_PYTHON_FALLBACK`` can be changed from the default list of interpreters by setting the ``ansible_interpreter_python_fallback`` variable. diff --git a/docs/docsite/rst/porting_guides/porting_guide_core_2.12.rst b/docs/docsite/rst/porting_guides/porting_guide_core_2.12.rst index bb6ff0a72dd..2d60bf26b0a 100644 --- a/docs/docsite/rst/porting_guides/porting_guide_core_2.12.rst +++ b/docs/docsite/rst/porting_guides/porting_guide_core_2.12.rst @@ -44,7 +44,7 @@ Playbook Python Interpreter Discovery ============================ -The default value of ``INTERPRETER_PYTHON_FALLBACK`` changed to ``auto``. The list of Python interpreters in ``INTERPRETER_PYTHON_FALLBACK`` changed to prefer Python 3 over Python 2. The combination of these two changes means the new default behavior is to quietly prefer Python 3 over Python 2 on remote hosts. Previously a deprecation warning was issued in situations where interpreter discovery would have used Python 3 but the interpreter was set to ``/usr/bin/python``. +The default value of ``INTERPRETER_PYTHON`` changed to ``auto``. The list of Python interpreters in ``INTERPRETER_PYTHON_FALLBACK`` changed to prefer Python 3 over Python 2. The combination of these two changes means the new default behavior is to quietly prefer Python 3 over Python 2 on remote hosts. Previously a deprecation warning was issued in situations where interpreter discovery would have used Python 3 but the interpreter was set to ``/usr/bin/python``. ``INTERPRETER_PYTHON_FALLBACK`` can be changed from the default list of interpreters by setting the ``ansible_interpreter_python_fallback`` variable.