docs: tell customers how to get ansible-playbook on every platform#21
Merged
Conversation
The manual install doc listed ansible-core as a prerequisite without telling the customer how to obtain it — and ansible-core does not run natively on Windows, which left Windows customers stuck. Add an upfront "Get a shell with ansible-playbook" section to docs/install-manual.md. Recommend Azure Cloud Shell first: it ships with ansible-core preinstalled, runs from any browser including Windows, and is already adjacent to the customer's AAP. Below it, cover Linux (dnf/apt/pip), macOS (brew/pip), and Windows-via-WSL2 as alternatives with actual install commands. Also reframe the Hub-token prerequisite as optional. infra.aap_configuration is published on public Galaxy, so a customer with no Hub setup (e.g. in fresh Cloud Shell) can install the loader without configuring anything. The Hub token is only required if the user already routes Galaxy through Hub. install-with-ai.md updated in lockstep so both paths agree. No separate Windows install guide — a single doc with a platform section keeps the rest (env vars, loader invocation, verification) DRY across all OS targets. Closes #20. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #20.
The manual install doc said "you need
ansible-core" without telling the customer how to obtain it. That left Windows customers stuck — ansible-core doesn't run natively on Windows.This PR adds a "Get a shell with
ansible-playbook" section that recommends Azure Cloud Shell as the easy path (zero install, browser-based, works from any Windows machine, comes with ansible-core preinstalled, runs adjacent to the customer's AAP), followed by Linux/macOS/WSL2 alternatives with actual install commands.Why Cloud Shell first
For a customer running Red Hat Managed AAP on Azure, Cloud Shell is already adjacent infrastructure. It removes three problems at once:
~/.ansible/ansible.cfgsetup required — which leads to the second change in this PR.Hub-token prereq reframed
Both install docs previously said a working
~/.ansible/ansible.cfgwith an Automation Hub token was required. That assumed a Red Hat-employee setup.infra.aap_configurationis actually published on public Galaxy (galaxy.ansible.com), so a customer with a fresh Cloud Shell or vanilla laptop canansible-galaxy collection install -r aap_config/requirements.ymlwith no Hub config at all.The prereq is now reframed as (Optional — Red Hat employees only).
No separate Windows install guide
Considered and rejected. ~90% of the install doc is platform-agnostic (env vars, the loader command, AAP verification). A separate
install-windows.mdwould have to duplicate all of it. A single doc with a platform section keeps everything DRY and the Windows path discoverable from the same TOC as everyone else.Files
docs/install-manual.md— new "Get a shell withansible-playbook" section + softened Hub-token prereq + improved troubleshooting line.docs/install-with-ai.md— same changes for the AI path; points to the install-manual section for platform install commands.CHANGELOG.md— entry under[Unreleased] / Changed.Test plan
yamllintclean locallyansible-lintclean locallyinstall-manual.md#get-a-shell-with-ansible-playbookanchor verified)🤖 Generated with Claude Code