Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-26 02:11:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

add specter setup and contributing template

Browse Source
This commit is contained in:
Lucy Cifferello
2020-10-19 14:20:35 -06:00
parent c2399f1444
commit 6532ddcce7
15 changed files with 216 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@@ -2,18 +2,12 @@
At Start9, we see great value in maintaining clear and accurate documentation for our already simple and friendly products. These docs are a continuous work-in-progress, and we welcome contributions from our partners and customers.
## Contributing to the docs
If you notice a mistake in the docs, or you have an idea for improving them, we would like to know about it. You can either fix the mistake yourself and submit a pull request, or you can report the mistake by submitting an issue.
### Submitting an issue
Click on the "Issues" tab in the top navbar. Provide a good title and describe clearly the mistake or improvement.
### Submitting a pull request
## Runbook
This project uses [Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html) and [Restructured Text](https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html)
### Dependencies
Install [python3](https://docs.python-guide.org/starting/install3/osx/)
Install sphinx and dependencies:
@@ -23,11 +17,32 @@ pip3 install sphinx-autobuild
pip3 install sphinx-book-theme
```
run: `sphinx-autobuild source build/html` to activate a live-reload environment on `localhost:8000`.
### Development
Run: `sphinx-autobuild source build/html` to activate a live-reload environment on `localhost:8000`.
The main configuration file for this project is located at `./source/conf.py`.
The navigation structure is aligned with the folder/file organization under `./source/`. This is where the individual page `.rst` files live and can be edited.
If any css or table of contents organization changes, run: `make clean html`.
## Contributing to the docs
If you notice a mistake in the docs, or you have an idea for improving them, we would like to know about it. You can either fix the mistake yourself and submit a pull request, or you can report the mistake by submitting an issue.
### Guide Templates
We welcome contributions to add a guide to this documentation repository. Please follow the templates provided [here](./source/contributing/template) and use proper `rst` style syntax.
All images should be placed in `./source/_static/images` with descriptive labeling.
Figure directives should include an alt description.
### Submitting an issue
Click on the "Issues" tab in the top navbar. Provide a good title and describe clearly the mistake or improvement.
### Submitting a pull request
Click on the "Pull requests" tab in the top navbar. Select the green "New pull request button" in the top right section. Select your branch for the compare dropdown, and master as the base. Provide an appropriate title and summary of the changes in the pull request description. Changes will be reviewed and merged when satisfactory.