Rewrite Split GPG-2 tutorial #1514
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I am not very convinced by my own edits. I tried to keep the old version as much as possible while trying to reorganize the content structure. I don't really understand Split GPG-2, so I only provided instructions from my own experience. * limit references to smart cards and go straight up to the point * insert instructions about installation * follow the documentation style guide as much as possible * detail the configuration options in "Advanced usage" This piece of software merits better documentation!
|
Update: while trying to rewrite again this page, I ended up with two other PRs: I also find out about the Diataxis method and I'm using it to clarify the page. |
I came across the diataxis approach and used it to get a better understanding of this page. Additionnaly, I did this: * move instructions to edit a policy and to enable a service qube to the related pages * clean the structure of the server options and make them cross-referenceable using `:confval:` role
parulin
force-pushed
the
split-gpg2-install
branch
from
33b669c to
67ee078
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Warning
This PR is a work in progress
This could be a way to fix QubesOS/qubes-issues#9953 but it is still incomplete and doesn't provide best practices.
Current status
I am not very convinced by my own edits. I tried to keep the old version as much as possible while trying to reorganize the content structure. I don't really understand Split GPG-2, so I only provided instructions from my own experience.
This software deserves better documentation! Any help would be useful, you can pull request against my personal branch :)
TODO
split-gpg2-dom0- [ ]
debug_log- [ ]
source_keyring_dir