Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrate docs to Markdown and update docs
## Why is the change being made? This change is made because reStructured text could be a more difficult style of documentation to adapt to (for newer developers) than Markdown. ## What has changed to address the problem? This change removes the Sphinx reStructured text documentation in GCS and replaces it with a MkDocs Markdown text documentation structure. Everyone contributing to the project will have to follow the instructions under `docs/contributing/getting-started.md`. There is additional added documentation to address the following: - How to work with GCS (running, building, and testing) - Installing MkDocs to see docs locally in `localhost:8000`. - Adding control messages for manual vehicle control - Adding geofencing field to start messages ## How was this change tested? This change was tested by checking if the docs looked fine when running `npm run docs`.
- Loading branch information
Showing
37 changed files
with
1,400 additions
and
2,331 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Directories for eslint to ignore | ||
|
||
dist | ||
docs/_build | ||
site |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,11 @@ | ||
# Ignore system generated files/folders | ||
# Ignore generated files | ||
.DS_Store | ||
package-lock.json | ||
docs/make.bat | ||
docs/Makefile | ||
|
||
# Ignore generated folders | ||
dist | ||
node_modules | ||
docs/_build | ||
site | ||
|
||
# Ignore .env file (should be set per system) | ||
.env |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
plugins: | ||
# Use style guide preset | ||
- remark-preset-lint-markdown-style-guide | ||
|
||
# Added rules | ||
- [lint-maximum-line-length, 100] | ||
- [lint-rule-style, ----------------------------------------------------------------------------------------------------] | ||
- [lint-definition-case, false] | ||
- [lint-list-item-indent, tab-size] | ||
- [lint-ordered-list-marker-value, ordered] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Directories for stylelint to ignore | ||
|
||
dist | ||
docs/_build | ||
site |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# NGCP Ground Control Station | ||
|
||
[![Build Status](https://travis-ci.com/NGCP/GCS.svg?branch=master)](https://travis-ci.com/NGCP/GCS) | ||
[![Documentation Status](https://readthedocs.org/projects/ground-control-station/badge/?version=latest)](https://ground-control-station.readthedocs.io/en/latest/?badge=latest) | ||
[![dependencies Status](https://david-dm.org/NGCP/GCS/status.svg)](https://david-dm.org/NGCP/GCS) | ||
[![devDependencies Status](https://david-dm.org/NGCP/GCS/dev-status.svg)](https://david-dm.org/NGCP/GCS?type=dev) | ||
|
||
## Introduction | ||
|
||
The [Northrop Grumman Collaboration Project][] presents the Ground Control Station (GCS). This | ||
project's objective is to view and set missions for all autonomous vehicle platforms in the project. | ||
|
||
Documentation for the GCS can be found [here](https://ground-control-station.readthedocs.io/). | ||
|
||
## Quick start | ||
|
||
### Setting things up | ||
|
||
You will need the LTS version of [Node.js][]. | ||
|
||
Open up your command line application and clone this repository | ||
|
||
```bash | ||
git clone https://github.com/NGCP/GCS.git | ||
``` | ||
|
||
### Running the program | ||
|
||
Create a [Mapbox][] account and obtain a public API access token. Create a `.env` file, copy the | ||
content of the `.env.example` to it, and replace `your-access-token` with your own access token. | ||
|
||
```bash | ||
MAPBOX_TOKEN=your-access-token | ||
``` | ||
|
||
Install all required third-party libraries and run the program: | ||
|
||
```bash | ||
npm install | ||
npm start | ||
``` | ||
|
||
## License | ||
|
||
[MIT][] | ||
|
||
[Northrop Grumman Collaboration Project]: http://www.ngcpcalpoly.com/about.html | ||
[Node.js]: https://nodejs.org/ | ||
[Mapbox]: https://www.mapbox.com/ | ||
[MIT]: https://github.com/NGCP/GCS/blob/master/LICENSE |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.