Guides

This is a template that allows anyone with access to the P1 Static Sites IL-2 Repo (which is practically anyone) to create their own static documentation site.

A working example from which this template derives is here: AFOTEC OT Guide

The goal is to make it easy for your people to read relevant guidance for their jobs anywhere: work, home, and on mobile.

Stack

JS, HTML, CSS. A React project, it is totally front end/client side, with the exception of a few dependencies and python code for document prep.

• More specifically, this project was made using Gatsby and the Gatsby Gitbook Starter

How to Use

This project requires a basic understanding of JavaScript, Markdown, and React (if you want to make changes).

• read the Gatsby docs
  • you need to install Gatsby. It may be as simple as npm install -g gatsby-cli at the command line, but to be sure you should first read the docs
• read the Gitbook starter docs
  • Gitbook-readme.md in this project's root folder has the pertinent bits
• clone this repo to your computer
• use npm install at the command line to install the dependencies
• change out the AFOTEC svg for one of your own
• to change and add content, follow the markdown and markdown folder conventions as seen in the folder called 'content_structure_example'
  • the index file at the root of the content folder is for your initial loading page
• to see your site as you build it, run gatsby develop
• to optimize your code for deployment on a server, run gatsby build
  • your code should land in a folder called 'public', and this will be the code you'll want to send to be served up on Platform One (not the code you use here in this repo to build it)

How to Host on Platform One

You'll need an account. Luckily, P1 offers free accounts for the purpose of talking on Mattermost, use of Confluence, and Jira. I recommend joining Military Coders by clicking here. Then, ask about how you can become a contributor on Repo1. Once you have access to Repo1 (free), follow the conventions in the readme on Static Sites. An example is here but don't use this exact example, because that's my site. This will instruct the Repo1 server on how to process and display your site.

Note: Static Sites on Repo1 is for public releasible information only. There is a blog construct for CUI in the works, but this is not that project.

Good luck! Reach out to @agent on MatterMost if you have additional questions or would just like to show me how you are using this template