google / google/certificate-transparency-go
Expand and simplify the Migrillian README doc
- Dominant language
- Go
- Stars
- 1.2k
- Forks
- 322
- Avg merge
- 3d 4h
- Merged PRs (30d)
- 5
Description
https://github.com/google/certificate-transparency-go/tree/master/trillian/migrillian
Locally copying the contents of CT logs for experimentation and playing is a thing which comes up quite frequently, and we often cite Migrillian as one mechanism. However, the current docs are quite sparse and are very technical from the offset (talking about PREORDERED_LOGS, etc.).
It'd be nice to have some more accessible introductory docs and a perhaps HOWTO+Dockers images, etc. to help folks get started.
Contributor guide
Research direction
Read the existing README and documentation under trillian/migrillian, starting with the current technical introduction and its references to PREORDERED_LOGS. Document an accessible introduction and a HOWTO for copying CT logs, including the Docker images mentioned in the issue; done means new users can follow the setup without beginning with internal terminology.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100