IntersectMBO / IntersectMBO/cardano-db-sync
Improve docker documentation
- Dominant language
- Haskell
- Stars
- 318
- Forks
- 168
- PR merge metrics
- No merged PRs in 30d
Description
### Business Hypothesis
The documentation needs to explain Docker and k8s use.
Draft document: https://docs.google.com/document/d/1L-S1Avu5eUhMl8tg-tHuTMySY_jCibWUXlkgI_27ytQ/edit
### Drivers
-Provide clear documentation for Docker use.
### Functional Requirements
- [ ] Operational documentation for running a dockerised `cardano-node` and `cardano-db-sync` environment
- [ ] Details on how to run Docker images
- [ ] ~~Using Dockerfiles~~ we explicitly use nix to generate docker images, unless that changes we will not provide Dockerfiles
- [x] How to start `docker-compose` with new flags like `--disable-ledger` https://github.com/input-output-hk/cardano-db-sync/pull/1236
- [ ] How to set state directory - https://github.com/input-output-hk/cardano-db-sync/issues/1040
- [ ] Migrate user facing documentation to ? https://github.com/input-output-hk/cardano-world
### NFRs
-none
### External Dependencies
-none
### DoD
-reviewed and approved by team
Contributor guide
Assessment
This issue has not been assessed yet.