matrix-org / matrix-org/matrix-hookshot

Is /data really a data directory?

Open
#896 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

T-Documentation
Dominant language
TypeScript
Stars
450
Forks
95
Avg merge
1d 2h
Merged PRs (30d)
23

Description

If I understand the documentation correctly, `/data` is just used for reading the configuration files and the passkey. Isn't it rather a _configuration directory_ then? It could also be mounted read-only if that is the case.

Would be good to know also for deploying this in a (swarm) cluster.

(By the way, the links to `helm/hookshot` in the documentation are broken.)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the documentation sections describing /data and the helm/hookshot links, then verify whether the directory contains only configuration files and the passkey. Done means clarifying the directory's purpose and mount mode for cluster deployment, and correcting the broken links.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm
Domain
documentation, infrastructure
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.