{"action":"closed","issue":{"url":"https://api.github.com/repos/freedomofpress/securedrop/issues/1133","labels_url":"https://api.github.com/repos/freedomofpress/securedrop/issues/1133/labels{/name}","comments_url":"https://api.github.com/repos/freedomofpress/securedrop/issues/1133/comments","events_url":"https://api.github.com/repos/freedomofpress/securedrop/issues/1133/events","html_url":"https://github.com/freedomofpress/securedrop/issues/1133","id":111283606,"number":1133,"title":"Separate documentation for users and developers","user":{"login":"conorsch","id":657862,"avatar_url":"https://avatars.githubusercontent.com/u/657862?v=3","gravatar_id":"","url":"https://api.github.com/users/conorsch","html_url":"https://github.com/conorsch","followers_url":"https://api.github.com/users/conorsch/followers","following_url":"https://api.github.com/users/conorsch/following{/other_user}","gists_url":"https://api.github.com/users/conorsch/gists{/gist_id}","starred_url":"https://api.github.com/users/conorsch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/conorsch/subscriptions","organizations_url":"https://api.github.com/users/conorsch/orgs","repos_url":"https://api.github.com/users/conorsch/repos","events_url":"https://api.github.com/users/conorsch/events{/privacy}","received_events_url":"https://api.github.com/users/conorsch/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/freedomofpress/securedrop/labels/docs","name":"docs","color":"d4c5f9"}],"state":"closed","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2015-10-13T22:20:08Z","updated_at":"2015-12-02T18:17:28Z","closed_at":"2015-12-02T18:17:28Z","body":"The `docs/` folder right now sandwiches all of the docs together. As we move toward creating a more readable docs platform, we should partition the documentation to target two separate groups.\r\n\r\n### Technical documentation\r\nThese docs explain the developer environment and provide a path for contributing to the project. Explanations should cover the virtualized environments used for testing, the various test suites, the CI pipelines, and contributor guidelines. These docs are good candidates for moving:\r\n\r\n* `apparmor_profiles.md`\r\n* `creating_deb.md`\r\n* `develop.md`\r\n* `logging.md`\r\n* `snap_ci.md`\r\n* `spec_tests.md`\r\n\r\n### User documentation\r\nThe heart of the docs, for actual users of SecureDrop. Specifically, this includes three categories of users: journalists, sources, and admins. Targeted guides for each user role should be prominently displayed and easy to come back to—preferably with a \"next\" button that will allow folks to pick up where they left off.\r\n"}}