From 8de2122b5c5ed5f99231993207fc7c9620f0da5c Mon Sep 17 00:00:00 2001 From: Sorin Sbarnea Date: Thu, 28 Mar 2024 14:10:52 +0000 Subject: [PATCH] Minor documentation fixes - advertise ansible-dev-tools as an installation alternative - fixed some broken or redirected URLs - fixed some typos Related: [AAP-19818](https://issues.redhat.com/browse/AAP-19818) --- README.md | 6 +++--- docs/conf.py | 2 +- docs/rundown.rst | 11 +++++++++++ tox.ini | 2 +- 4 files changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index fc04113..5df4fea 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,9 @@ It does the following: Note: The API (library) part of this package is not officially supported and might change as time goes on. CLI commands should be considered stable within -major verions (the `X` of version `X.Y.Z`). +major versions (the `X` of version `X.Y.Z`). -Documentation can be found on [ansible-sign.readthedocs.io](https://ansible-sign.readthedocs.io/en/latest/) +Documentation can be found on [ansible-sign.readthedocs.io](https://ansible.readthedocs.io/projects/sign/en/latest/) including a -[rundown/tutorial](https://ansible.github.io/ansible-sign/rundown.html) +[rundown/tutorial](https://ansible.readthedocs.io/projects/sign/en/latest/rundown.html) explaining how to use the CLI for basic project signing and verification. diff --git a/docs/conf.py b/docs/conf.py index 4196a8d..ccd2c36 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -164,7 +164,7 @@ html_theme_options = { "display_version": False, "titles_only": False, - "documentation_home_url": "https://ansible.github.io/ansible-sign/", + "documentation_home_url": "https://ansible.readthedocs.io/projects/sign/en/latest/", } # Add any paths that contain custom themes here, relative to this directory. diff --git a/docs/rundown.rst b/docs/rundown.rst index 6ac9648..e544dc9 100644 --- a/docs/rundown.rst +++ b/docs/rundown.rst @@ -70,6 +70,17 @@ Run the following command to install ``ansible-sign``: $ pip install ansible-sign +.. note:: + + An **alternative** approach to install ``ansible-sign`` is using the ``ansible-dev-tools`` package. + `Ansible Development Tools (ADT) `_ is a single Python package that includes all necessary tools to + set up a development environment, generate new collections, build and test the content consistently, resulting in robust automation. + + .. code-block:: shell + + # This also installs ansible-core if it is not already installed + $ pip3 install ansible-dev-tools + Once it’s installed, run: .. code-block:: shell diff --git a/tox.ini b/tox.ini index 7087438..35f82e3 100644 --- a/tox.ini +++ b/tox.ini @@ -1,6 +1,6 @@ [tox] minversion = 3.24 -envlist = py3,lint +envlist = py3,lint,docs isolated_build = True