UPDATE 2020-11-11: The initial port to Markdown with HTML output is COMPLETE
A port of the 2013 SFTE Reference Handbook to bookdown
Join us as a collaborator over at the SFTE GitHub handbook-2013 project!
Proofreading the HTML website output at https://society-of-flight-test-engineers.github.io/handbook-2013/ and submitting "issues" (reporting deficiencies or proposing enhancements at https://github.com/Society-of-Flight-Test-Engineers/handbook-2013/issues
The project is organized around
A. a "task board" (look for "cards" in the "To do" column) https://github.com/Society-of-Flight-Test-Engineers/handbook-2013/projects/1
B. an "issue list" (these are similar to a watch item or deficiency report) where issues can be discussed, labeled as "bugs" or "enhancements", assigned to collaborators, linked to task cards, and much more! https://github.com/Society-of-Flight-Test-Engineers/handbook-2013/issues
C. a "wiki" (think Wikipedia-style pages filled with our persistent, descriptive and prescriptive content ) https://github.com/Society-of-Flight-Test-Engineers/handbook-2013/wiki
Questions are best asked via an Issue by clicking the "New Issue" button on the Issue page, or clicking this link https://github.com/Society-of-Flight-Test-Engineers/handbook-2013/issues/new
Looking forward to your contribution!
Contributing to the modernization of the Society is a BENEFIT OF MEMBERSHIP.
The folder pandoc-output
contains the raw results of converting .docx
files to
.md
files.
The raw Pandoc output is copied to the folder handbookdown
and edited to create a bookdown
project.
The folder docs
contains the HTML output of bookdown
.
This is where https://society-of-flight-test-engineers.github.io/handbook-2013/ is served from.
The Project is where tasks are created and tracked in the form of Kanban cards, most associated with Issues.
The wiki is the place for persistent discussion about the handbook
It includes the Handbook Markdown Style Guide for contributors.
Here's a diagram of the process.
As of 2020-02-28, the coarse conversion and "initial scrub" from the source Microsoft Publisher and/or Word documents to Markdown text files (*.Rmd
) is complete!
GitHub Actions will be used to render and publish the handbook. This will allow for changes to be confirmed using a standard configuration, and for previews to be made available without having to install software on a personal device.
For more details, see the GitHub Actions Notes file in this repo.