diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md index bf829d82..1a73915f 100644 --- a/.github/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -1,4 +1,4 @@ # Community Code of Conduct Please see the official -[Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html). +[Ansible Community Code of Conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html). diff --git a/README.md b/README.md index bff9b795..85c74395 100644 --- a/README.md +++ b/README.md @@ -28,13 +28,13 @@ The curated list of tools installed as part of the Ansible automation developer ## Communication -Refer to our [Communication guide](https://ansible.readthedocs.io/projects/dev-tools/contributor-guide/#talk-to-us) for details. +Refer to our [Communication guide](https://docs.ansible.com/projects/dev-tools/contributor-guide/#talk-to-us) for details. ## Installation `python3 -m pip install ansible-dev-tools` -A VsCode compatible devcontainer is also available which is a great way to develop ansible content. The image name is [community-ansible-dev-tools](https://ansible.readthedocs.io/projects/dev-tools/container/). +A VsCode compatible devcontainer is also available which is a great way to develop ansible content. The image name is [community-ansible-dev-tools](https://docs.ansible.com/projects/dev-tools/container/). ## Usage @@ -77,4 +77,4 @@ $ podman logs -f ansible-devtools-server ## Documentation -For more information, please visit our [documentation](https://ansible.readthedocs.io/projects/dev-tools/) page. +For more information, please visit our [documentation](https://docs.ansible.com/projects/dev-tools/) page. diff --git a/devspaces/README.md b/devspaces/README.md index e8edf959..8c3d00c1 100644 --- a/devspaces/README.md +++ b/devspaces/README.md @@ -3,7 +3,7 @@ An OpenShift Dev Spaces image specifically for Ansible development. This comes pre-built with the [Ansible Development Tools](https://github.com/ansible/ansible-dev-tools) package. -For documentation on how to use these tools, please refer to [ADT docs](https://ansible.readthedocs.io/projects/dev-tools/). +For documentation on how to use these tools, please refer to [ADT docs](https://docs.ansible.com/projects/dev-tools/). This image is built and published each time a new change is merged to the main branch of ansible-dev-tools project. A release tag is created for each new diff --git a/docs/container.md b/docs/container.md index d1238487..60a26cc6 100644 --- a/docs/container.md +++ b/docs/container.md @@ -29,18 +29,18 @@ You can simply copy over the `.devcontainer` directory to your Ansible project a To use this image with [Github Codespaces](https://docs.github.com/en/codespaces/overview), copy the [`devcontainer.json`](https://github.com/ansible/ansible-dev-tools/blob/main/.devcontainer/devcontainer.json) in this repo to your project and push to Github. -**Note:** If you are planning to start writing a new Ansible playbook project or collection, use [Ansible Creator](https://ansible.readthedocs.io/projects/creator) to scaffold it for you and your project/collection will already have all the `.devcontainer` files ready. +**Note:** If you are planning to start writing a new Ansible playbook project or collection, use [Ansible Creator](https://docs.ansible.com/projects/creator/) to scaffold it for you and your project/collection will already have all the `.devcontainer` files ready. ### Using this image as an EE -This image can also be used as an Ansible Execution Environment (EE). If you're not familiar with what an EE is, checkout the documentation in [Getting started with EE](https://docs.ansible.com/ansible/devel/getting_started_ee/index.html). It is shipped with the following Ansible collections: +This image can also be used as an Ansible Execution Environment (EE). If you're not familiar with what an EE is, checkout the documentation in [Getting started with EE](https://docs.ansible.com/projects/ansible/devel/getting_started_ee/index.html). It is shipped with the following Ansible collections: - ansible.netcommon - ansible.posix - ansible.scm - ansible.utils -You can also create a new EE based on this with more Ansible collections (or Python/System packages) of your choice by using Ansible Builder. Read this [documentation](https://ansible.readthedocs.io/projects/builder/en/latest/) to know about ansible-builder. +You can also create a new EE based on this with more Ansible collections (or Python/System packages) of your choice by using Ansible Builder. Read this [documentation](https://docs.ansible.com/projects/builder/en/latest/) to know about ansible-builder. The below example shows how to make a custom EE that adds the `amazon.aws` and `cisco.nxos` collections as well as the `ansible-pylibssh` python package to this image. @@ -62,7 +62,7 @@ The below example shows how to make a custom EE that adds the `amazon.aws` and ` ansible-builder build -t custom-ee:latest --prune-images -v3 ``` -Once this image is built, you can use [`ansible-navigator`](https://ansible.readthedocs.io/projects/navigator/) to reference this image and run your playbooks! +Once this image is built, you can use [`ansible-navigator`](https://docs.ansible.com/projects/navigator/) to reference this image and run your playbooks! ### Using with podman from the command-line diff --git a/docs/contributor-guide.md b/docs/contributor-guide.md index f862ada8..a85870e6 100644 --- a/docs/contributor-guide.md +++ b/docs/contributor-guide.md @@ -75,18 +75,18 @@ At this moment the devspaces container is not tested by the CI, so it is importa - [Posts tagged with 'devtools'](https://forum.ansible.com/tag/devtools): subscribe to participate in project-related conversations. - [Social Spaces](https://forum.ansible.com/c/chat/4): gather and interact with fellow enthusiasts. - [News & Announcements](https://forum.ansible.com/c/news/5): track project-wide announcements including social events. - - [Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn): used to announce releases and important changes. + - [Bullhorn newsletter](https://docs.ansible.com/projects/ansible/devel/community/communication.html#the-bullhorn): used to announce releases and important changes. - We are also available on Matrix in the [#devtools:ansible.com](https://matrix.to/#/#devtools:ansible.com) room. Possible security bugs should be reported via email to . -For more information about communication, see the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html). +For more information about communication, see the [Ansible communication guide](https://docs.ansible.com/projects/ansible/devel/community/communication.html). ## Code of Conduct Please see the official [Ansible Community Code of Conduct]. -[Ansible Community Code of Conduct]: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html +[Ansible Community Code of Conduct]: https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html [creating your fork on github]: https://docs.github.com/en/get-started/quickstart/contributing-to-projects diff --git a/docs/devspaces.md b/docs/devspaces.md index 3304b182..b0abb710 100644 --- a/docs/devspaces.md +++ b/docs/devspaces.md @@ -73,4 +73,4 @@ Contributions to this repository are welcome! If you find any issues or have sug ## Code of Conduct -We ask all of our community members and contributors to adhere to the [Ansible code of conduct](http://docs.ansible.com/ansible/latest/community/code_of_conduct.html). If you have questions or need assistance, please reach out to our community team at [codeofconduct@ansible.com](mailto:codeofconduct@ansible.com) +We ask all of our community members and contributors to adhere to the [Ansible code of conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html). If you have questions or need assistance, please reach out to our community team at [codeofconduct@ansible.com](mailto:codeofconduct@ansible.com) diff --git a/docs/index.md b/docs/index.md index d631bfa5..c420f08f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -30,16 +30,16 @@ For those looking for an IDE-based experience, we also recommend you get familia The curated list of tools installed as part of the Ansible Development Tools includes: -- [ansible-builder](https://ansible.readthedocs.io/projects/builder/): Ansible Builder automates the process of building execution environments using the schemas and tooling defined in various Ansible Collections and by the user. -- [ansible-core](https://ansible.readthedocs.io/projects/ansible/): Ansible is a radically simple IT automation platform that makes your applications and systems easier to deploy and maintain. Automate everything from code deployment to network configuration to cloud management, in a language that approaches plain English, using SSH, with no agents to install on remote systems. -- [ansible-creator](https://ansible.readthedocs.io/projects/creator/): The fastest way to generate all your ansible content! -- [ansible-dev-environment](https://ansible.readthedocs.io/projects/dev-environment/): A pip-like install for Ansible collections. -- [ansible-lint](https://ansible.readthedocs.io/projects/lint/): Checks playbooks for practices and behavior that could potentially be improved. -- [ansible-navigator](https://ansible.readthedocs.io/projects/navigator/) A text-based user interface (TUI) for Ansible. -- [ansible-sign](https://ansible.readthedocs.io/projects/sign/): Utility for signing and verifying Ansible project directory contents. -- [molecule](https://ansible.readthedocs.io/projects/molecule/): Molecule aids in the development and testing of Ansible content: collections, playbooks and roles -- [pytest-ansible](https://ansible.readthedocs.io/projects/pytest-ansible/): A pytest plugin that enables the use of ansible in tests, enables the use of pytest as a collection unit test runner, and exposes molecule scenarios using a pytest fixture. -- [tox-ansible](https://ansible.readthedocs.io/projects/tox-ansible/): The tox-ansible plugin dynamically creates a full matrix of python interpreter and ansible-core version environments for running integration, sanity, and unit for an ansible collection both locally and in a Github action. tox virtual environments are leveraged for collection building, collection installation, dependency installation, and testing. +- [ansible-builder](https://docs.ansible.com/projects/builder/en/latest/): Ansible Builder automates the process of building execution environments using the schemas and tooling defined in various Ansible Collections and by the user. +- [ansible-core](https://docs.ansible.com/projects/ansible/latest/): Ansible is a radically simple IT automation platform that makes your applications and systems easier to deploy and maintain. Automate everything from code deployment to network configuration to cloud management, in a language that approaches plain English, using SSH, with no agents to install on remote systems. +- [ansible-creator](https://docs.ansible.com/projects/creator/): The fastest way to generate all your ansible content! +- [ansible-dev-environment](https://docs.ansible.com/projects/dev-environment/): A pip-like install for Ansible collections. +- [ansible-lint](https://docs.ansible.com/projects/lint/): Checks playbooks for practices and behavior that could potentially be improved. +- [ansible-navigator](https://docs.ansible.com/projects/navigator/) A text-based user interface (TUI) for Ansible. +- [ansible-sign](https://docs.ansible.com/projects/sign/en/latest/): Utility for signing and verifying Ansible project directory contents. +- [molecule](https://docs.ansible.com/projects/molecule/): Molecule aids in the development and testing of Ansible content: collections, playbooks and roles +- [pytest-ansible](https://docs.ansible.com/projects/pytest-ansible/): A pytest plugin that enables the use of ansible in tests, enables the use of pytest as a collection unit test runner, and exposes molecule scenarios using a pytest fixture. +- [tox-ansible](https://docs.ansible.com/projects/tox-ansible/): The tox-ansible plugin dynamically creates a full matrix of python interpreter and ansible-core version environments for running integration, sanity, and unit for an ansible collection both locally and in a Github action. tox virtual environments are leveraged for collection building, collection installation, dependency installation, and testing. ## Getting started @@ -47,4 +47,4 @@ To get started, follow the [installation](installation.md) steps to get ansible- ## Community -Questions, feedback, or contributions? Join the Ansible community on [Matrix](https://matrix.to/#/#devtools:ansible.com) or [open an issue](https://github.com/ansible/ansible-dev-tools/issues/new). We're dedicated to supporting your Ansible automation journey! For more details on how to interact with our community, please visit the [Ansible Communication](https://docs.ansible.com/ansible/latest/community/communication.html) page. +Questions, feedback, or contributions? Join the Ansible community on [Matrix](https://matrix.to/#/#devtools:ansible.com) or [open an issue](https://github.com/ansible/ansible-dev-tools/issues/new). We're dedicated to supporting your Ansible automation journey! For more details on how to interact with our community, please visit the [Ansible Communication](https://docs.ansible.com/projects/ansible/latest/community/communication.html) page. diff --git a/docs/user-guide/building-collection.md b/docs/user-guide/building-collection.md index 3a4e9acf..b9822c23 100644 --- a/docs/user-guide/building-collection.md +++ b/docs/user-guide/building-collection.md @@ -48,7 +48,7 @@ $ ansible-galaxy collection list - Due to its installation method using pip4a, you can change module code dynamically and observe the effects during playbook execution. -NOTE: for details regarding the module development, refer to the [ansible module development docs](https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_general.html). +NOTE: for details regarding the module development, refer to the [ansible module development docs](https://docs.ansible.com/projects/ansible/latest/dev_guide/developing_modules_general.html). ## Using ansible-lint to check module syntax in the playbook diff --git a/docs/user-guide/ci-setup.md b/docs/user-guide/ci-setup.md index ea0d42df..1abf8095 100644 --- a/docs/user-guide/ci-setup.md +++ b/docs/user-guide/ci-setup.md @@ -61,5 +61,5 @@ The workflow uses tox-ansible, pytest-ansible to generate the matrix, which is u Refer to the [tox-ansible documentation] to see more options. -[pytest-ansible]: https://ansible.readthedocs.io/projects/pytest-ansible/ -[tox-ansible documentation]: https://ansible.readthedocs.io/projects/tox-ansible/ +[pytest-ansible]: https://docs.ansible.com/projects/pytest-ansible/ +[tox-ansible documentation]: https://docs.ansible.com/projects/tox-ansible/ diff --git a/docs/user-guide/content-best-practices.md b/docs/user-guide/content-best-practices.md index 0dda9d73..8647140a 100644 --- a/docs/user-guide/content-best-practices.md +++ b/docs/user-guide/content-best-practices.md @@ -64,4 +64,4 @@ tox -e sanity-py3.11-2.14,sanity-py3.11-devel --ansible --conf tox-ansible.ini Refer to the [tox-ansible documentation] to see more options. -[tox-ansible documentation]: https://ansible.readthedocs.io/projects/tox-ansible/ +[tox-ansible documentation]: https://docs.ansible.com/projects/tox-ansible/ diff --git a/docs/user-guide/test-isolation.md b/docs/user-guide/test-isolation.md index f823b180..49d516f5 100644 --- a/docs/user-guide/test-isolation.md +++ b/docs/user-guide/test-isolation.md @@ -77,6 +77,6 @@ the responsibility to pre-install these before running the tools. --- -[moleclue]: https://ansible.readthedocs.io/projects/molecule/ -[ansible-lint]: https://ansible.readthedocs.io/projects/lint/ -[ansible-dev-environment]: https://ansible.readthedocs.io/projects/dev-environment/ +[moleclue]: https://docs.ansible.com/projects/molecule/ +[ansible-lint]: https://docs.ansible.com/projects/lint/ +[ansible-dev-environment]: https://docs.ansible.com/projects/dev-environment/ diff --git a/docs/user-guide/testing.md b/docs/user-guide/testing.md index 64f8909f..8a8e61dd 100644 --- a/docs/user-guide/testing.md +++ b/docs/user-guide/testing.md @@ -130,5 +130,5 @@ This will avoid running tests with either of ansible-core 2.9 or devel. Refer to the [tox-ansible documentation] to see more options. -[pytest-ansible documentation]: https://ansible.readthedocs.io/projects/pytest-ansible/ -[tox-ansible documentation]: https://ansible.readthedocs.io/projects/tox-ansible/ +[pytest-ansible documentation]: https://docs.ansible.com/projects/pytest-ansible/ +[tox-ansible documentation]: https://docs.ansible.com/projects/tox-ansible/ diff --git a/mkdocs.yml b/mkdocs.yml index d25ba66d..e01ad197 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ --- site_name: Ansible Development Tools Documentation -site_url: https://ansible.readthedocs.io/projects/dev-tools/ +site_url: https://docs.ansible.com/projects/dev-tools/ repo_url: https://github.com/ansible/ansible-dev-tools edit_uri: blob/main/docs/ copyright: Copyright © Red Hat, Inc. @@ -59,13 +59,13 @@ extra: name: GitHub alternate: - name: ansible-dev-tools - link: https://ansible.readthedocs.io/projects/dev-tools/ + link: https://docs.ansible.com/projects/dev-tools/ - name: ansible-lint - link: https://ansible.readthedocs.io/projects/lint/ + link: https://docs.ansible.com/projects/lint/ - name: ansible-navigator - link: https://ansible.readthedocs.io/projects/navigator/ + link: https://docs.ansible.com/projects/navigator/ - name: molecule - link: https://ansible.readthedocs.io/projects/molecule/ + link: https://docs.ansible.com/projects/molecule/ - name: vscode-ansible (github marketplace) link: https://marketplace.visualstudio.com/items?itemName=redhat.ansible - name: creator-ee (github) @@ -73,7 +73,7 @@ extra: - name: pytest-ansible link: https://github.com/ansible-community/pytest-molecule - name: tox-ansible - link: https://ansible.readthedocs.io/projects/tox-ansible/ + link: https://docs.ansible.com/projects/tox-ansible/ - name: creator linke: https://github.com/ansible/ansible-creator - name: ansible-compat @@ -119,7 +119,7 @@ plugins: merge_init_into_class: yes show_submodules: yes inventories: - - url: https://docs.ansible.com/ansible/latest/objects.inv + - url: https://docs.ansible.com/projects/ansible/latest/objects.inv domains: [py, std] markdown_extensions: diff --git a/pyproject.toml b/pyproject.toml index f3cd1992..95e7f7ad 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -39,7 +39,7 @@ dynamic = ["version"] [project.urls] changelog = "https://github.com/ansible/ansible-dev-tools/releases" -documentation = "https://ansible.readthedocs.io/projects/dev-tools/" +documentation = "https://docs.ansible.com/projects/dev-tools/" homepage = "https://github.com/ansible/ansible-dev-tools" repository = "https://github.com/ansible/ansible-dev-tools"