freedomofpress / ansible-role-grsecurity

The documentation and build system for the grsecurity kernel maintained by the Freedom of the Press Foundation for SecureDrop
GNU General Public License v2.0
49 stars 13 forks source link

Rewrite documentation #28

Closed conorsch closed 8 years ago

conorsch commented 8 years ago

With the addition of several Ansible roles for managing the build and install process for the grsecurity-patched kernel, we need to update the documentation to explain how the roles should be used. In particular, the grsecurity_patch_type and grsecurity_build_strategy vars should be explained in detail.

The step-by-step build docs currently in build.md can be folded into the docs to explain how to approach the grsecurity_build_strategy=manual use case, which is currently the default behavior of the build role.

conorsch commented 8 years ago

The new docs should include a brief explanation about the non-standard bundled nature of this role. We'll defer discussion of separating the build and install roles into distinct repositories for now. Docs checklist: [moved to OP so github displays a progress bar on the issues page]

conorsch commented 8 years ago

Working on this now.