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

🛠️ Hutch Installation Docs should make prerequisites clearer #11

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

🛠️ Hutch Installation Docs should make prerequisites clearer #11

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

Current documentation for installing Hutch advises to specify Hutch's configuration before installing it using Ansible.

However, a great deal of this configuration depends on already knowing exactly what prerequisite or other peripheral components the user will want Hutch to interact with.

The Hutch documentation should give step by step guidance on deciding what is needed or wanted, and then what configuration becomes necessary as a result.

Only then is it appropriate to move on to the step of configuring Hutch.

Tasks

  • Add Prerequisite decision guidance to docs
  • Add Prerequisite dependent Hutch configuration guidance

Acceptance Criteria

  • The Hutch docs outline possible prerequisite components
  • The docs provide guidance on when which components might be needed
  • The docs cover how to configure Hutch when a given component is being used
@beforan beforan self-assigned this Jan 26, 2024
@beforan beforan changed the title Hutch Installation Docs - Prerequisites setup [🛠️] Hutch Installation Docs should make prerequisites 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 [🛠️] Hutch Installation Docs should make prerequisites clearer 🛠️ Hutch Installation Docs should make prerequisites 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