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

Reorders and extends the Admin guide #132

Merged
merged 1 commit into from
Jan 14, 2021
Merged

Conversation

zenmonkeykstop
Copy link
Contributor

@zenmonkeykstop zenmonkeykstop commented Jan 13, 2021

Status

Ready for review

Description of Changes

  • Clarifies admin responsibilities
  • Adds sections for Admin Interface, SSH commands, securedrop-admin
  • documents org name and upload flag config settings
  • Clarifies sync tasks for multi-admin teams

Testing

Docs-only - review for clarity and correctness

Release

Should be merged once freedomofpress/securedrop#5679 is added to a release.

Checklist (Optional)

  • Doc linting (make docs-lint) passed locally
  • Doc link linting (make docs-linkcheck) passed not checked
  • You have previewed (make docs) docs at http://localhost:8000

@eloquence eloquence self-assigned this Jan 13, 2021
@eloquence
Copy link
Member

(Taking first pass; note merge conflict in admin.rst due to recent merges)

docs/admin.rst Outdated Show resolved Hide resolved
docs/admin.rst Outdated Show resolved Hide resolved
docs/admin.rst Outdated Show resolved Hide resolved
docs/admin.rst Outdated Show resolved Hide resolved
docs/admin.rst Outdated Show resolved Hide resolved
Copy link
Member

@eloquence eloquence left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great on first pass, much clearer and more accessible structure, and more concise step-by-step instructions! Thank you. :) Mostly nits in the review so far (and currently has one merge conflict), will take one more spin before merging.

- Clarifies admin responsibilities
- Adds sections for Admin Interface, SSH commands, securedrop-admin
- documents org name and upload flag config settings
- Clarifies sync tasks for multi-admin teams
Copy link
Member

@eloquence eloquence left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Took another spin, all looks great to me - thank you!

@eloquence eloquence merged commit d3caffe into main Jan 14, 2021
@zenmonkeykstop zenmonkeykstop deleted the cleanup-admin-section branch January 14, 2021 20:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants