OSSForks/opsschool-curriculum
1
0
Fork 0
mirror of https://github.com/opsschool/curriculum.git synced 2026-01-15 12:15:03 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Update installation instructions & style

Browse Source 
Signed-off-by: Mike Fiedler <miketheman@gmail.com>
This commit is contained in:
Mike Fiedler
2019-01-05 16:35:58 -05:00
parent 3d228362c8
commit 654786a5e3
1 changed files with 21 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -6,7 +6,7 @@ Ops School Curriculum
[![Support via Gratipay](https://cdn.rawgit.com/gratipay/gratipay-badge/2.3.0/dist/gratipay.svg)](https://gratipay.com/Ops-School/)
The current documentation based on these sources can be seen at:
http://www.opsschool.org/
<http://www.opsschool.org/>
Welcome!
@@ -26,15 +26,13 @@ If you are looking to add content, fix formatting, syntax, typos or other
wonderful things, please follow this process:
* Read the [Style Guide](http://www.opsschool.org/en/latest/meta/style_guide.html)
* Install Sphinx: `easy_install Sphinx sphinx_rtd_theme` or `pip install -r requirements.txt`
* Install Sphinx: `pip install -r requirements.txt` (This is best done in a virtual environment.)
* Fork the `opsschool/curriculum` repository to your own account
* Check out a branch to make your changes on: `git checkout --branch <my_topic>`
* Execute `make html` to build the docs in to `_build/`
* Make your changes
* Execute `make html` again and verify your changes don't cause any
warnings/errors
* Commit with a descriptive message, and submit a pull request from your branch
to `master`
* Execute `make html` again and verify your changes don't cause any warnings/errors
* Commit with a descriptive message, and submit a pull request from your branch to `master`
* One of the editors will review the change, and either merge it or provide some
feedback. Community review is also encouraged.