Closed
Milestone
Nov 8, 2023–Jul 15, 2024
All the things $documentation
A milestone where we focus solely on improving our documentation.
We might create a few more issues based on sigsum/project/documentation#40 (closed), or loosely based some of our improvements based on those comments. When rgdd and nisse talked briefly about this, our notes said:
- have a good entrypoint to find docs in different places from www.sigsum.org/docs
- probably will want to also backref to www.sigsum.org/docs from some of our repos
- some kind of getting-started guide/tutortial is needed in sigsum-go
- (implicit from this: we're happy to continue having docs about our tools in the repo where tools live.)
- first step in log-go is to "polish" a bit, and make sure there are hints as feedback to know if the log server is up and running correctly. It's currently meant as a getting-started guide, but it needs a bit of work and is not trivial to find.
EDIT 2024-05-28: dropped a few issues that are not as high priority (backlog), added issues on getting README and man pages for sigsum-go. We're hoping to wrap this milestone up before PETS.
EDIT 2024-09-01: dropped the remaining four issues (glossary, getting started fig, use-case example, command-line manpages) -- at large this milestone is done. We'll do some more gradual improvements when time permits.
Loading
Loading
Loading
Loading