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

Rename navigation bar "Install Securedrop" section to "Deploy Securedrop" #221

Closed
damko opened this issue May 14, 2021 · 4 comments
Closed

Comments

@damko
Copy link
Contributor

damko commented May 14, 2021

Describe the change

I propose to rename navigation bar "Install Securedrop" section to "Deploy Securedrop"

How will this impact users?

More clarity. I'm not a native English speaker but "Install Securedrop" makes me think of installing a software. This whole section describes how to setup or deliver a whole system of hardware plus software therefore "Deploy Securedrop" seems more accurate.
Also, notice that in the same section there is a child page with title "Install Securedrop" which, at a first glance, seems like a repetition.

User Research Evidence

No evidence, just personal taste.

@eloquence
Copy link
Member

I agree that the "Installation" section currently has wider scope than a typical software installation - but note that we also already have a "Deployment Best Practices" section (mapped to a deployment folder in the docs), which covers stuff like the clearnet landing page, and the physical environment. I think if we reorganize here, we need to do more than just rename that one section.

@damko
Copy link
Contributor Author

damko commented May 15, 2021

To be clear, my angle is to render the perception of a new comer. I believe that good documentation should be written by those who know and then evaluated by those who don't (my case).
@eloquence is there any plan in place for the reorganization of the doc?

@eloquence
Copy link
Member

@eloquence is there any plan in place for the reorganization of the doc?

Not really, but @gonzalo-bulnes has started some work in #141 to reorganize a section of the documentation following the Divio documentation system described here: https://documentation.divio.com/

I find the Divio system quite useful and would suggest we continue to keep it in mind for further changes to the information architecture.

@nathandyer
Copy link
Contributor

The spirit of this issue was completed as part of the reorganization work in #441

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

No branches or pull requests

3 participants