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

Update all documentation for 0.4 release #1544

Closed
9 tasks done
heartsucker opened this issue Jan 30, 2017 · 9 comments
Closed
9 tasks done

Update all documentation for 0.4 release #1544

heartsucker opened this issue Jan 30, 2017 · 9 comments
Assignees
Labels
Milestone

Comments

@heartsucker
Copy link
Contributor

heartsucker commented Jan 30, 2017

By the looks of things, there are enough major changes that there will need to be significant alterations to the docs. This should include.

Docs issues for 0.4

@psivesely
Copy link
Contributor

Definitely worth waiting until we're at a "stable" point. The UI will never be static, but after we get in all of @ninavizz's suggestions there'll be a lot less churn.

@heartsucker
Copy link
Contributor Author

Agreed. Just putting it here so it could be added to the 0.4 project to ensure it gets done.

@redshiftzero redshiftzero added this to the 0.4 milestone Feb 1, 2017
@psivesely psivesely added the docs label Mar 2, 2017
@psivesely
Copy link
Contributor

I think this should also include convergence of the "latest" and "stable" versions of the documentation on our website.

@conorsch
Copy link
Contributor

conorsch commented Mar 2, 2017

@fowlslegs I wouldn't converge them—"stable" still has merit as a label in that it reflects the most recently shipped release, and "latest" represents whatever the head of current development includes.

@anxiousnix
Copy link
Contributor

Someone who recently set up the latest stable version of SecureDrop emailed the following comments, which I'm attaching to this issue:

  1. The data transfer device pages seem to be for another version of tails. I’m running the latest 2.11. At the very least, you should put the version number next to one of the screenshots.
  2. The firewall section could be a lot better. You ship a sample configuration with a bunch of redacted fields. How about simply walking the user through how to change the template and how to load it? For the screenshots on the pf2440, the one you recommend, it would be nice if you had that info perhaps in a table or in text or something that I don’t have to squint at a low-res jpg to try and figure out what you have. I get that firewalls are complicated, but if somebody buys straight off your list of hardware and puts the computers on a dedicated subnet inside the firewall, should be able to give me a better cookbook approach.

It is debatable whether or not we want to put version numbers next to screenshots, but recent versions of Tails (as compared to the ones screencapped), use a different version of GNOME and other applications, which have UI changes, so those will need to be updated.

@redshiftzero
Copy link
Contributor

redshiftzero commented May 3, 2017

Great feedback, thanks @edenemmanuel for passing those along.

[Added docs checklist to OP, hope that's cool @heartsucker ;)]

In the interest of not duplicating work, we should do the Tails-based documentation tasks described here in Tails 3.0 (see issue #1551).

@redshiftzero
Copy link
Contributor

@edenemmanuel is currently testing the 0.4 docs in #1695 and #1688. If you're currently working on one of the other docs items from the checklist above, please comment!

@conorsch
Copy link
Contributor

The only remaining items on the checklist are updating screenshots to use Tails 3 for the various role guides. Now that the interface is stable, and Tails 3 is released and well tested, it's a good time to get those screenshot updates in. I'll handle.

@conorsch
Copy link
Contributor

All items on the checklist are now resolved. Also recently merged #2003 and #2015 with additional documentation updates related to 0.4.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

6 participants