Basic Tools

Audience

Any ToIP member that is interested in contributing should familiarize themselves with a basic set of tools and education material.

Roles

Contributors may fall into one of the following categories:

Role	Activities
Content Author	Use an editor of choice to write sections of the target deliverable using Markdown files as fragments of the ultimate deliverable document or specification.
GitHub skilled developer	Github savvy contributor that collects Markdown files from other contributors and manages commits and pull-requests as a representative of the team of contributors/
Both	Provider of content and manager of Github interactions.

Contribution Readiness

Education

The following list provides some examples for how to get quickly acquainted with the Markdown Language.

• Markdown Tutorial
• Markdown Documentation
  • Getting Started with Markdown
  • Markdwon Basics
  • Mastering the Markdown Language

Authoring Tools

The following list provides a few examples for how to setup your local environment with one or more content authoring tools.

• Markdown Converters for Word Processors
  • MS-Word to Markdown
    • Word-to-Markdown
    • Writage
    • How to convert Word Docs to Markdown
  • Google Docs to Markdown
    • G-Suite Plugins
    • How to convert Google Docs to Markdown
• Integrated development environment (IDE)
  • Visual Studio
  • Atom

Development Environment Dependencies

Required Software	MacOS Installation Instructions	Windows Installation Instructions
Docker	Docker Desktop	Docker Desktop
make	Command Line Tools for Xcode	Install Chocolatey Package Installer, then install make via choco
git	Git Installer	Git Installer

Content Authoring Environments

The contributors associated with each ToIP Deliverable will decide which one of two of the ToIP themed content authoring environments will be used. You can learn more about contributing preparation steps for each of the options:

Authoring Environment	Usage	View Demo(s)
ToIP MkDocs Material Theme Contributors Guide	General Documentation and Specification development	ToIP MkDocs Theme for Documentation, ToIP MkDocs Theme for Specs
Spec-Up for ToIP which is derived from Spec-Up	Specification development	ToIP Spec-up Repo, Baseline Spec-up Demo