matrix-org / matrix-org/matrix-hookshot
Replace helm chart with ess-helm instructions
- Dominant language
- TypeScript
- Stars
- 450
- Forks
- 95
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 23
Description
At some point in the near future we'll be removing https://github.com/matrix-org/matrix-hookshot/tree/main/helm and instead suggest users use https://github.com/element-hq/ess-helm to install Hookshot. To be clear, the upstream helm chart will still support standalone Hookshot installation (with an existing homeserver) and will also hopefully do a better job of making it ergonomic to use.
The hope is that with ESS being a well-maintained project this will allow myself and the other Hookshot maintainers to focus on building the software without having to also maintain the Helm chart.
When the helm chart exists for ess-helm, we will deprecate the current helm charts and remove in a future release. Instructions on how to Helm will be included in the hookshot docs.
Contributor guide
Research direction
Start by inspecting the existing helm directory at https://github.com/matrix-org/matrix-hookshot/tree/main/helm and the Hookshot documentation. Check whether the ess-helm chart is available, then update the Helm instructions to point to it while preserving the standalone-installation context. Done means the documentation reflects the intended chart transition without removing the current chart prematurely.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- helm
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 42/100