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 "virtual environments" section in navigation bar #10

Open
damko opened this issue May 14, 2021 · 2 comments
Open

Add "virtual environments" section in navigation bar #10

damko opened this issue May 14, 2021 · 2 comments

Comments

@damko
Copy link
Contributor

damko commented May 14, 2021

Describe the change

I propose to move these pages from the navigation section "Developer documentation" to a new section above called "Virtual Environments":

  • Virtual environments: Servers
  • Virtual environments: Admin Workstation
  • Virtual environments: Using Qubes
  • Portable SecureDrop Demo

Eventually the page files could be moved to a separate folder like "venvs" but, what's important to me is to have a separate section like this:

securedrop_menu_virtual_environments

How will this impact users?

  1. I think that a less crowded "Developer documentation" section would be beneficial for everyone
  2. New administrators won't have to look through all the documentation before finding what they need to have a virtualized environment for evaluation purposes. At the same time developers won't have any difficulty in finding what they need even if it's not in "their" section. Win-win

User Research Evidence

I'm new to Securedrop at it was hard for me to navigate the documentation. Only after two days with my nose in the documentation I realized that a portable setup is described: I simply couldn't see it.

Additional context

@eloquence
Copy link
Member

@damko These virtual environments are only intended for development, so we do want to keep them clearly situated in the dev docs. That said, the information architecture of the development section of the docs definitely needs improvement.

@damko
Copy link
Contributor Author

damko commented May 15, 2021

@eloquence yes, on a second analysis, I reached your same conclusion. It should stay in the development section however I still felt the need for a "hit the ground running" kind of tutorial which would satisfy the needs of those willing to evaluate SecureDrop so I wrote it (currently ~70% of the draft). I'm writing it while I build my own "evaluation environment". When completed I'll submit it as a ticket so that you guys can have a look at it and understand if it's something desirable.

@eloquence eloquence transferred this issue from freedomofpress/securedrop-docs Sep 26, 2022
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

2 participants