Skip to content

Commit

Permalink
Expand installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
cristianonicolai committed Dec 14, 2023
1 parent e11a220 commit 37d33d8
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 1 deletion.
1 change: 1 addition & 0 deletions .config/dictionary.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
devel
libera
testenv
Uninstallation
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The curated list of tools installed as part of the Ansible Development Tools inc

## Getting started

To get started, please follow the [installation](installation.md) steps to get ADT setup and jump into [Getting Started](getting-started.md) guide for details.
To get started, please follow the [installation](installation.md) steps to get ADT setup and jump into [Getting Started](getting-started.md) guide for more details.

## Community

Expand Down
28 changes: 28 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,34 @@ hide:

`pip install ansible-dev-tools`

Once installation is completed, visit [Getting Started](getting-started.md) guide for more details about ADT usage.

### Latest Releases

- GitHub
Visit the [ADT GitHub releases page](https://github.com/ansible/ansible-dev-tools/releases) to view the latest releases. Each release includes detailed release notes outlining new features, improvements, and bug fixes.

- PyPI
The [PyPI page for ADT](https://pypi.org/project/ansible-dev-tools/) provides information on the latest stable release and allows you to download specific versions of the package.

## Upgrade

To upgrade ADT to the latest version, you can use the following pip command:

`pip install --upgrade ansible-dev-tools`

## Downgrade

If needed, you can downgrade ADT to a specific version using the following pip command:

`pip install ansible-dev-tools==desired-version`

## Uninstallation

If you need to uninstall ADT, you can use the following pip command:

`pip uninstall ansible-dev-tools`

## Usage

In addition to installing each of the above tools, `ansible-dev-tools` provides an easy way to show the versions of the content creation tools that make up the current development environment.
Expand Down

0 comments on commit 37d33d8

Please sign in to comment.