Ops School Curriculum
Python Makefile Batchfile
Latest commit dc7676e Sep 7, 2016 @dkorzhevin dkorzhevin committed with miketheman Update security_201.rst (#318)
Add AppArmor besides SELinux, as it is popular in Debian and Ubuntu based distros.
Permalink
Failed to load latest commit information.
_build need some empty dirs Oct 11, 2012
_static need some empty dirs Oct 11, 2012
_templates need some empty dirs Oct 11, 2012
datacenters Merge pull request #191 from peacekeeper0/patch-7 Nov 22, 2013
meta Updated disaster_recovery.rst (#316) Aug 11, 2016
.gitignore Exclude any direnv artifacts from project Aug 10, 2016
.travis.yml Remove deprecated pip flag Aug 10, 2016
LICENSE Added Creative Commons license Oct 12, 2012
Makefile Initialised sphinx Oct 11, 2012
README.md Update badges May 26, 2016
active_directory_101.rst Wrapped to 80 characters Apr 3, 2013
active_directory_201.rst Started work on some AD docs Mar 30, 2013
application_components_201.rst Rabbitmq (#277) Aug 10, 2016
architecture_101.rst Syllabus porting DONE. Oct 18, 2012
architecture_201.rst Syllabus porting DONE. Oct 18, 2012
backups.rst Fixing a few typos Jul 15, 2013
bcp.rst bcp: errant index section Aug 4, 2013
boot_process_101.rst Update boot_process_101.rst (#269) Aug 10, 2016
capacity_planning.rst Mega trailing whitespace commit Dec 26, 2012
careers.rst updated index.rst for style, added ref link to careers Apr 5, 2013
common_services.rst toctree needs a blank line before content Jun 23, 2013
conf.py Exclude any direnv artifacts from project Aug 10, 2016
config_management.rst Puppet Introduction (#282) Aug 14, 2016
cron_101.rst Fix indents Jun 18, 2014
databases_101.rst Fix typos. Apr 8, 2016
databases_201.rst Syllabus porting DONE. Oct 18, 2012
deployment_101.rst Fixing a bunch of typos Dec 26, 2012
deployment_201.rst Mentioned supervisord and circus process watchers. Dec 28, 2014
dhcp.rst Typo Jan 18, 2014
disaster_recovery.rst Updated disaster_recovery.rst (#316) Aug 11, 2016
dns_101.rst Fix typos. Apr 7, 2016
dns_201.rst Syllabus porting DONE. Oct 18, 2012
filesystems_101.rst Update filesystems_101.rst Apr 5, 2016
glossary.rst fix a few typos and style conforms. Dec 15, 2013
hardware_101.rst Fix typos Jul 27, 2014
http_101.rst Fix typos. Apr 7, 2016
http_201.rst Mega trailing whitespace commit Dec 26, 2012
identity_management.rst these were all issues raised in previous pull requests that needed to… Jun 26, 2013
index.rst Add a supplemental recommended reading list. Dec 24, 2014
inits.rst Fixing a few typos Jul 15, 2013
introduction.rst fixed all malformed todos (#314) Aug 10, 2016
kernel_tuning.rst and even more stuff added, we are up to page 6 on the old syllabus Oct 13, 2012
labs.rst s/Idempodency/Idempotency : 2 errors Apr 22, 2015
learning.rst learning page updates to style for build correctness Apr 20, 2014
loadbalancing_101.rst Add paragraph on nginx Sep 24, 2015
logs_101.rst more formatting corrections, change logrotate homepage and rewrite se… Nov 9, 2014
logs_201.rst Syllabus porting DONE. Oct 18, 2012
make.bat Initialised sphinx Oct 11, 2012
monitoring_101.rst Correct capitalization and minor changes. Apr 11, 2016
monitoring_201.rst Fix typos Jul 27, 2014
netbooting.rst Update netbooting.rst Nov 26, 2014
networking_101.rst Minor improvement. Apr 6, 2016
networking_201.rst Add sections on network troubleshooting (#256) Aug 10, 2016
outages.rst Fixing a few typos Jul 15, 2013
package_management_101.rst fixed all malformed todos (#314) Aug 10, 2016
postmortems.rst adding titles to the new files Jan 10, 2013
programming_101.rst correct underline length post typo fix from 5079f94 Jul 27, 2014
programming_201.rst fixed all malformed todos (#314) Aug 10, 2016
reading_list.rst Add a supplemental recommended reading list. Dec 24, 2014
remote_filesystems_101.rst Syllabus porting DONE. Oct 18, 2012
remote_filesystems_201.rst Syllabus porting DONE. Oct 18, 2012
requirements.txt update requirements file for Sphinx 1.2 Dec 31, 2013
security_101.rst Merge pull request #280 from gtilma/master Apr 7, 2016
security_201.rst Update security_201.rst (#318) Sep 7, 2016
seealso.rst updates links for some redirects and remote vs local Feb 20, 2013
shell_tools_101.rst Fix typos Jul 27, 2014
shells_101.rst fixed all malformed todos (#314) Aug 10, 2016
smtp_101.rst Syllabus porting DONE. Oct 18, 2012
smtp_201.rst Syllabus porting DONE. Oct 18, 2012
soft_skills_101.rst small edits from Pat Cable Mar 30, 2013
soft_skills_201.rst Fix typos Jul 27, 2014
statistics.rst Syllabus porting DONE. Oct 18, 2012
stats_diagnosing.rst added sar to stats diagnosing Oct 15, 2012
sysadmin_101.rst added Jean large tech firm developer story (#317) Aug 14, 2016
sysadmin_tools.rst Merge pull request #299 from fjcapdevila/patch-9 Apr 6, 2016
syscalls.rst removed some left-over # in the output May 27, 2015
system_daemons_101.rst Syllabus porting DONE. Oct 18, 2012
text_editing_101.rst Update text_editing_101.rst Oct 5, 2014
text_editing_201.rst Capitalize Vim per vim.org Oct 21, 2012
troubleshooting_101.rst Correct title Apr 6, 2016
unix_101.rst and even more stuff added, we are up to page 6 on the old syllabus Oct 13, 2012
unix_201.rst and even more stuff added, we are up to page 6 on the old syllabus Oct 13, 2012
unix_signals.rst Minor format improvement. Apr 5, 2016
virtualization_101.rst Fixing a few typos Jul 15, 2013
virtualization_201.rst Syllabus porting DONE. Oct 18, 2012
windows_101.rst adding empty windows_101 section and mentioning windows in the "how t… Mar 8, 2013

README.md

Ops School Curriculum

Build Status GitHub issues

Support via Gratipay

The current documentation based on these sources can be seen at: http://www.opsschool.org/

Welcome!

If you have arrived here, you are probably interested in helping out. So thank you for your time.

Things you should know:

This is the only Markdown file in the repository, as it's not meant to be included in the documentation itself.

If you are looking to add content, fix formatting, syntax, typos or other wonderful things, please follow this process:

  • Read the Style Guide
  • Install Sphinx: easy_install Sphinx sphinx_rtd_theme or pip install -r requirements.txt
  • 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
  • One of the editors will review the change, and either merge it or provide some feedback. Community review is also encouraged.

If you submit a pull request and would like to have your name associated with the project, add it to the meta/contributions.rst file!

Some cool things:

  • vim-common contains a reStructuredText syntax highlighter
  • The Emacs support via rst-mode comes as part of the docutils package under /docutils/tools/editors/emacs/rst.el

Note about internal links

When creating a link to another page inside the curriculum, use Sphinx's built-in cross-reference mechanisms to achieve this.

Examples:

  • linking to a top-level document such as "Text Editing 101" should be done inline, like so:

      See :doc:`text_editing_101` for details...
    

    where the name provided is the RST file path. The title will be linked to the document like so:

      See <em>Text Editing 101</em> for details...
    
  • linking to a reference point, such as a sub-topic on a page should be done by creating a globally unique reference point, such as:

      .. _gnu-screen:
    
      GNU Screen
      ----------
    

    and using this inline anywhere in the docs like so:

      See :ref:`gnu-screen` for more details.
    

    The sub-topic's title will be replaced in the hyperlink as well.

After modifications to links, please run make linkcheck to see the status of all the links in the docs.

More on cross-referencing can be read in the Sphinx Docs.

Bitdeli Badge