Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add use-case/cookbook style documentation #16

Open
t3hmrman opened this issue Sep 10, 2018 · 2 comments
Open

Add use-case/cookbook style documentation #16

t3hmrman opened this issue Sep 10, 2018 · 2 comments
Labels
documentation markdown documentation, in-line CLI documenatation enhancement

Comments

@t3hmrman
Copy link
Contributor

While the sheesy documentation is pretty fantastic already, I felt there was a little to be desired as far as the various vault pages, in particular vault partitions.

I was looking for basically group-like support -- being able to share a secret with a group of users but not necessarily a different group, more concretely to be able to differentiate secrets for staging/production. When looking at the vault partitions add documentation it was unfortunately a little unclear

Since what I was looking for is likely a very common usecase, it might be nice to explain it directly, either on the add page itself or in a separate "recipes" or "use case examples" or something section.

@Byron Byron added enhancement documentation markdown documentation, in-line CLI documenatation labels Sep 11, 2018
@Byron
Copy link
Collaborator

Byron commented Sep 11, 2018

Thanks a lot for letting me know! I think you are absolutely right, documentation about this feature in particular is lacking, even though your initial assessment is right: It's exactly what you want to model groups.
These days I am rather unmotivated to work on any of my open-source projects, but my mere reply here shows it's slowly returning :).
With every issue raised here and increased demand, I will grow happier to finish the documentation, which to this date is on my todo-list.

@t3hmrman
Copy link
Contributor Author

No problem, thank you for the work! I was actually planning on writing something like this in rust myself after I'd become an avid user of git-crypt but thanks to your project i don't have to (I had just started thinking of how to implement groups and do all the rehashing that would likely be necessary, etc)!

Also don't worry, I plan to contribute some code -- take care of yourself and the motivation will return eventually! Hopefully soon I can send something and you can sit back and review! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation markdown documentation, in-line CLI documenatation enhancement
Projects
None yet
Development

No branches or pull requests

2 participants