4 ms·
THIS ^^^ Google took this approach internally using markdown files (If I remember correctly). Perforce is also going this way - https://www.perforce.com/manua
by malkia 6y ago
THIS ^^^
Google took this approach internally using markdown files (If I remember correctly).
Perforce is also going this way - https://www.perforce.com/manuals/swarm/Content/Swarm/basics.markdown.html https://www.perforce.com/manuals/swarm/Content/Swarm/basics.... - but I wish more (right now it's only in their "project overview pages.")
This allows for code reviews on the doc too, easier to auto-generate, fix, etc - than non-file interface like wiki.
- malkia 6y agoOne gotcha - if your playbook is stored there, make sure it's backup'd on secure external USB drives, as the source system, or the markdown render, or something else needed to accomplish this may go down, and now you and your team/project are going to be affected. Like pre-rendered to .html, .chm, even why not pdf files - whatever it takes just to be able for your oncall personnel to read them back if need to.
- tln 6y agoPresumably your on-call personnel will have those repos checked out?
- malkia 6y agoWhat if your source system goes down, can't connect to your local machine, needs to use VM - no the oncall needs to have the USB stick or more, and use it any other company laptop.
- q3k 6y agoHackdoc itself has a mode to run from a local checkout, with no other service dependencies (vs. the production mode that expects a git/grpc proxy service to access the live repository), and as it's Go it can easily be moved around as a single, relocatable binary that will run from nearly all operating systems.
- q3k 6y ago> Google took this approach internally using markdown files (If I remember correctly). Yes: https://www.usenix.org/sites/default/files/conference/protected-files/srecon16europe_slides_macnamara.pdf https://www.usenix.org/sites/default/files/conference/protec...