Giter Club home page Giter Club logo

handbook-2013's Introduction

UPDATE 2020-11-11: The initial port to Markdown with HTML output is COMPLETE

handbook-2013

A port of the 2013 SFTE Reference Handbook to bookdown

Join us!

Join us as a collaborator over at the SFTE GitHub handbook-2013 project!

How to collaborate

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

Project organization

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

How to ask questions

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.

Code organization

pandoc-output

The folder pandoc-output contains the raw results of converting .docx files to .md files.

handbookdown

The raw Pandoc output is copied to the folder handbookdown and edited to create a bookdown project.

docs

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.

GitHub tools being used for the project

Project

The Project is where tasks are created and tracked in the form of Kanban cards, most associated with Issues.

Wiki

The wiki is the place for persistent discussion about the handbook

It includes the Handbook Markdown Style Guide for contributors.

Process Diagram

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!

Process Diagram

Continuous Integration/Continuous Deployment (CI/CD)

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.

handbook-2013's People

Contributors

cooknl avatar flighttestfact avatar rwstanfo avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.