Skip to content

Commit f73219c

Browse files
gundalowclaude
andauthored
docs: update readthedocs.io URLs to docs.ansible.com equivalents (#641)
🤖 Generated with Claude Code https://claude.ai/code Co-authored-by: Claude <noreply@anthropic.com>
1 parent 93c3ba5 commit f73219c

File tree

14 files changed

+41
-41
lines changed

14 files changed

+41
-41
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Community Code of Conduct
22

33
Please see the official
4-
[Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
4+
[Ansible Community Code of Conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html).

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ The curated list of tools installed as part of the Ansible automation developer
2828

2929
## Communication
3030

31-
Refer to our [Communication guide](https://ansible.readthedocs.io/projects/dev-tools/contributor-guide/#talk-to-us) for details.
31+
Refer to our [Communication guide](https://docs.ansible.com/projects/dev-tools/contributor-guide/#talk-to-us) for details.
3232

3333
## Installation
3434

3535
`python3 -m pip install ansible-dev-tools`
3636

37-
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/).
37+
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/).
3838

3939
## Usage
4040

@@ -77,4 +77,4 @@ $ podman logs -f ansible-devtools-server
7777

7878
## Documentation
7979

80-
For more information, please visit our [documentation](https://ansible.readthedocs.io/projects/dev-tools/) page.
80+
For more information, please visit our [documentation](https://docs.ansible.com/projects/dev-tools/) page.

devspaces/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
An OpenShift Dev Spaces image specifically for Ansible development.
44

55
This comes pre-built with the [Ansible Development Tools](https://github.com/ansible/ansible-dev-tools) package.
6-
For documentation on how to use these tools, please refer to [ADT docs](https://ansible.readthedocs.io/projects/dev-tools/).
6+
For documentation on how to use these tools, please refer to [ADT docs](https://docs.ansible.com/projects/dev-tools/).
77

88
This image is built and published each time a new change is merged to the main
99
branch of ansible-dev-tools project. A release tag is created for each new

docs/container.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,18 @@ You can simply copy over the `.devcontainer` directory to your Ansible project a
2929

3030
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.
3131

32-
**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.
32+
**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.
3333

3434
### Using this image as an EE
3535

36-
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:
36+
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:
3737

3838
- ansible.netcommon
3939
- ansible.posix
4040
- ansible.scm
4141
- ansible.utils
4242

43-
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.
43+
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.
4444

4545
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.
4646

@@ -62,7 +62,7 @@ The below example shows how to make a custom EE that adds the `amazon.aws` and `
6262
ansible-builder build -t custom-ee:latest --prune-images -v3
6363
```
6464

65-
Once this image is built, you can use [`ansible-navigator`](https://ansible.readthedocs.io/projects/navigator/) to reference this image and run your playbooks!
65+
Once this image is built, you can use [`ansible-navigator`](https://docs.ansible.com/projects/navigator/) to reference this image and run your playbooks!
6666

6767
### Using with podman from the command-line
6868

docs/contributor-guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,18 +75,18 @@ At this moment the devspaces container is not tested by the CI, so it is importa
7575
- [Posts tagged with 'devtools'](https://forum.ansible.com/tag/devtools): subscribe to participate in project-related conversations.
7676
- [Social Spaces](https://forum.ansible.com/c/chat/4): gather and interact with fellow enthusiasts.
7777
- [News & Announcements](https://forum.ansible.com/c/news/5): track project-wide announcements including social events.
78-
- [Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn): used to announce releases and important changes.
78+
- [Bullhorn newsletter](https://docs.ansible.com/projects/ansible/devel/community/communication.html#the-bullhorn): used to announce releases and important changes.
7979

8080
- We are also available on Matrix in the [#devtools:ansible.com](https://matrix.to/#/#devtools:ansible.com) room.
8181

8282
Possible security bugs should be reported via email to
8383
<mailto:security@ansible.com>.
8484

85-
For more information about communication, see the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
85+
For more information about communication, see the [Ansible communication guide](https://docs.ansible.com/projects/ansible/devel/community/communication.html).
8686

8787
## Code of Conduct
8888

8989
Please see the official [Ansible Community Code of Conduct].
9090

91-
[Ansible Community Code of Conduct]: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html
91+
[Ansible Community Code of Conduct]: https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html
9292
[creating your fork on github]: https://docs.github.com/en/get-started/quickstart/contributing-to-projects

docs/devspaces.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,4 +73,4 @@ Contributions to this repository are welcome! If you find any issues or have sug
7373

7474
## Code of Conduct
7575

76-
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)
76+
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)

docs/index.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,21 +30,21 @@ For those looking for an IDE-based experience, we also recommend you get familia
3030

3131
The curated list of tools installed as part of the Ansible Development Tools includes:
3232

33-
- [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.
34-
- [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.
35-
- [ansible-creator](https://ansible.readthedocs.io/projects/creator/): The fastest way to generate all your ansible content!
36-
- [ansible-dev-environment](https://ansible.readthedocs.io/projects/dev-environment/): A pip-like install for Ansible collections.
37-
- [ansible-lint](https://ansible.readthedocs.io/projects/lint/): Checks playbooks for practices and behavior that could potentially be improved.
38-
- [ansible-navigator](https://ansible.readthedocs.io/projects/navigator/) A text-based user interface (TUI) for Ansible.
39-
- [ansible-sign](https://ansible.readthedocs.io/projects/sign/): Utility for signing and verifying Ansible project directory contents.
40-
- [molecule](https://ansible.readthedocs.io/projects/molecule/): Molecule aids in the development and testing of Ansible content: collections, playbooks and roles
41-
- [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.
42-
- [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.
33+
- [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.
34+
- [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.
35+
- [ansible-creator](https://docs.ansible.com/projects/creator/): The fastest way to generate all your ansible content!
36+
- [ansible-dev-environment](https://docs.ansible.com/projects/dev-environment/): A pip-like install for Ansible collections.
37+
- [ansible-lint](https://docs.ansible.com/projects/lint/): Checks playbooks for practices and behavior that could potentially be improved.
38+
- [ansible-navigator](https://docs.ansible.com/projects/navigator/) A text-based user interface (TUI) for Ansible.
39+
- [ansible-sign](https://docs.ansible.com/projects/sign/en/latest/): Utility for signing and verifying Ansible project directory contents.
40+
- [molecule](https://docs.ansible.com/projects/molecule/): Molecule aids in the development and testing of Ansible content: collections, playbooks and roles
41+
- [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.
42+
- [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.
4343

4444
## Getting started
4545

4646
To get started, follow the [installation](installation.md) steps to get ansible-dev-tools setup and check [User Guide](user-guide/index.md) for more details.
4747

4848
## Community
4949

50-
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.
50+
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.

docs/user-guide/building-collection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ $ ansible-galaxy collection list
4848

4949
- Due to its installation method using pip4a, you can change module code dynamically and observe the effects during playbook execution.
5050

51-
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).
51+
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).
5252

5353
## Using ansible-lint to check module syntax in the playbook
5454

docs/user-guide/ci-setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,5 +61,5 @@ The workflow uses tox-ansible, pytest-ansible to generate the matrix, which is u
6161

6262
Refer to the [tox-ansible documentation] to see more options.
6363

64-
[pytest-ansible]: https://ansible.readthedocs.io/projects/pytest-ansible/
65-
[tox-ansible documentation]: https://ansible.readthedocs.io/projects/tox-ansible/
64+
[pytest-ansible]: https://docs.ansible.com/projects/pytest-ansible/
65+
[tox-ansible documentation]: https://docs.ansible.com/projects/tox-ansible/

docs/user-guide/content-best-practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,4 @@ tox -e sanity-py3.11-2.14,sanity-py3.11-devel --ansible --conf tox-ansible.ini
6464

6565
Refer to the [tox-ansible documentation] to see more options.
6666

67-
[tox-ansible documentation]: https://ansible.readthedocs.io/projects/tox-ansible/
67+
[tox-ansible documentation]: https://docs.ansible.com/projects/tox-ansible/

0 commit comments

Comments
 (0)