-
Notifications
You must be signed in to change notification settings - Fork 4
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
Completed draft of Administrator guide #132
Open
jdormansteele
wants to merge
43
commits into
main
Choose a base branch
from
alt-site-ops
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains 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
in the quick start docs, please remove "pq-" from the service names. systemctl start pq-katzenpost-mixserver |
generally, remove "pq" from the docs if it appears anywhere; it serves no purpose other than to make names longer and more cumbersome. more of such strings containing "pq" are present in the installation doc as well. |
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.
Note: Pending PR https://github.com/katzenpost/website/pull/131needs to be merged before this PR is merged.
This draft of the entire Admin Guide is submitted for final review preliminary to publishing. Here is a new PDF of the guide:
admin_guide.pdf
The following topics are new:
Quickstart
quickstart.pdf
Installation
install.pdf
Several other topics have been touched with minor revisions.
Certain proposed topics related to configuration have been moved to a to-do directory and are not part of this draft. This is because configuration is currently an unresolved user experience and a subject of debate among the developers. This situation must not block the rest of the guide. The affected topics include Gensphinx, Tuning, a summary introduction, and any future topics such as a publicly usable genconfig.
The uncertainty surrounding configuration is handled in the new Installation topic with a recommendation to contact the project developers for assistance.
I request review of the new topics be completed and merged by the end of the week and that the finished document be published at that time. This will complete my responsibilities under WHS MoU 5.1, allowing me to invoice for it.