Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🛠️ Ansible usage docs for installing Hutch should be clearer #10

Open
4 tasks
beforan opened this issue Jan 26, 2024 · 0 comments
Open
4 tasks

🛠️ Ansible usage docs for installing Hutch should be clearer #10

beforan opened this issue Jan 26, 2024 · 0 comments
Assignees
Labels
🛠️ backlog This issue is a planned work item

Comments

@beforan
Copy link
Member

beforan commented Jan 26, 2024

Summary

Currently the documentation for installing, preparing and running Ansible Playbooks to install Hutch and it's direct dependencies isn't as clear as it could be.

The following enhancements are desirable:

  • Clarity around Ansible installation - link directly to installation documentation instead of the main Ansible homepage.
  • Clarity around what is required in terms of modifying the Hutch Service Description.

Tasks

  • Update link to Ansible installation docs
  • Clarify Service Description documentation

Acceptance Criteria

  • The Hutch documentation links directly to Ansible installation documentation
  • The Hutch documentation describes accurately what needs specifying in the Service Description file
@beforan beforan self-assigned this Jan 26, 2024
@beforan beforan changed the title Hutch Installation docs using Ansible updates [🛠️] Ansible usage docs for installing Hutch should be clearer Jan 26, 2024
@beforan beforan added the 🛠️ backlog This issue is a planned work item label Jan 26, 2024
@beforan beforan changed the title [🛠️] Ansible usage docs for installing Hutch should be clearer 🛠️ Ansible usage docs for installing Hutch should be clearer Jan 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🛠️ backlog This issue is a planned work item
Projects
None yet
Development

No branches or pull requests

1 participant