archivista
archivista copied to clipboard
in-toto
Archivista Guide
This issue is about creating the initial Archivista Guide.
We should keep the README.md more for developers and contributors We should provide the user with clear information about the following (not limited to).
- What is Archivista
- How to deploy Archivista
- How to configure the Archivista
- How to use Archivista
Parent issue
- [ ] #108
Some initial suggestions
- We should maintain the documentation as a code
- We should provide information focused on the audience of Arquivista, from IT Architects to DevOps and DevSecOps.
Hey 👋
Interesting that you take the perspective of keeping the README strictly for developers and contributors.
For me at least, having some simple user Quick Starts / getting going guides in the README (as long as they're short), is a very useful thing. When I want to start using a project, the Github README is actually the first place I go (e.g., https://github.com/anchore/syft and https://github.com/sigstore/cosign both have quick getting started guides).
It would be good to synchronise the discussions on this between https://github.com/in-toto/archivista and https://github.com/in-toto/witness, so the experience is the same 😄 and also not a duplicated effort
I would like to assist with this issue. I believe it would be beneficial to keep the README.md file focused on developers and contributors, while creating a separate file for users. Consolidating all information into a single document might overwhelm users and diminish their experience. Though, the README.md file could have a reference to the user doc e.g. USER-GUIDE.md.
