From 20eb1dca992ffe8ab19722bc7e0afb5fc99ce38f Mon Sep 17 00:00:00 2001 From: Sam Doran Date: Tue, 21 Jan 2020 15:13:25 -0500 Subject: [PATCH] Update Galaxy docs to use "token" rather than "API key" (#66644) We have called an API token many things. I changed the command line argument to "--token", so now I'm unifying the documentation. I looked at both Galaxy and Automation Hub and Galaxy is the only place that still uses the term "API Key", which it could be argued should change. --- .../rst/dev_guide/developing_collections.rst | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/docsite/rst/dev_guide/developing_collections.rst b/docs/docsite/rst/dev_guide/developing_collections.rst index f90369e7375..9088e7b5871 100644 --- a/docs/docsite/rst/dev_guide/developing_collections.rst +++ b/docs/docsite/rst/dev_guide/developing_collections.rst @@ -307,32 +307,32 @@ You can publish collections to Galaxy using the ``ansible-galaxy collection publ .. _galaxy_get_token: -Getting your token or API key -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Getting your API token +^^^^^^^^^^^^^^^^^^^^^^ -To upload your collection to Galaxy, you must first obtain an API token (``--api-key`` in the ``ansible-galaxy`` CLI command or ``token`` in the :file:`ansible.cfg` file under the ``galaxy_server`` section). The API token is a secret token used to protect your content. +To upload your collection to Galaxy, you must first obtain an API token (``--token`` in the ``ansible-galaxy`` CLI command or ``token`` in the :file:`ansible.cfg` file under the ``galaxy_server`` section). The API token is a secret token used to protect your content. To get your API token: -* For Galaxy, go to the `Galaxy profile preferences `_ page and click :guilabel:`API token`. -* For Automation Hub, go to https://cloud.redhat.com/ansible/automation-hub/token/ and click :guilabel:`Get API token` from the version dropdown. +* For Galaxy, go to the `Galaxy profile preferences `_ page and click :guilabel:`API Key`. +* For Automation Hub, go to https://cloud.redhat.com/ansible/automation-hub/token/ and click :guilabel:`Load token` from the version dropdown. Storing or using your API token ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Once you have retrieved your API token, you can store or use the token for collections in two ways: -* Pass the token to the ``ansible-galaxy`` command using the ``--api-key``. +* Pass the token to the ``ansible-galaxy`` command using the ``--token``. * Specify the token within a Galaxy server list in your :file:`ansible.cfg` file. -Using the ``api-key`` -..................... +Using the ``token`` argument +............................ -You can use the ``--api-key`` argument with the ``ansible-galaxy`` command (in conjunction with the ``--server`` argument or :ref:`GALAXY_SERVER` setting in your :file:`ansible.cfg` file). You cannot use ``apt-key`` with any servers defined in your :ref:`Galaxy server list `. +You can use the ``--token`` argument with the ``ansible-galaxy`` command (in conjunction with the ``--server`` argument or :ref:`GALAXY_SERVER` setting in your :file:`ansible.cfg` file). You cannot use ``apt-key`` with any servers defined in your :ref:`Galaxy server list `. .. code-block:: bash - ansible-galaxy collection publish ./geerlingguy-collection-1.2.3.tar.gz --api-key= + ansible-galaxy collection publish ./geerlingguy-collection-1.2.3.tar.gz --token= Specify the token within a Galaxy server list