mirror of
https://github.com/opsschool/curriculum.git
synced 2025-12-06 00:19:45 +01:00
Ops School Curriculum
dcabb147bd
* Add sections on network troubleshooting and working with network engineers * Apparently emphasize-lines doesn't work, so I just removed it. * Fix a small typo * Expound on net-tools deprecation. Turns out, only RHEL7 has officially deprecated usage, with other major distros just silently keeping both available. * Fix some style and linking issues * Grammar and style fixes in the netstat section * netstat is deprecated in favor of ss, which I didn't realize until now. Switched the whole netstat section to ss, and as requested by @miketheman, expounded a bit more on the options. * Add an example output for iftop and discuss availibility of the tool * Reword the section on network engineers and systems admins working together to have more empathy and less us vs them * Expound on the merits of ping and telnet as troubleshoot tools. * Fix minor RST syntax issue * Add an example of using ping for MTU path discovery |
||
|---|---|---|
| _build | ||
| _static | ||
| _templates | ||
| datacenters | ||
| meta | ||
| .gitignore | ||
| .travis.yml | ||
| active_directory_101.rst | ||
| active_directory_201.rst | ||
| application_components_201.rst | ||
| architecture_101.rst | ||
| architecture_201.rst | ||
| backups.rst | ||
| bcp.rst | ||
| boot_process_101.rst | ||
| capacity_planning.rst | ||
| careers.rst | ||
| common_services.rst | ||
| conf.py | ||
| config_management.rst | ||
| cron_101.rst | ||
| databases_101.rst | ||
| databases_201.rst | ||
| deployment_101.rst | ||
| deployment_201.rst | ||
| dhcp.rst | ||
| disaster_recovery.rst | ||
| dns_101.rst | ||
| dns_201.rst | ||
| filesystems_101.rst | ||
| glossary.rst | ||
| hardware_101.rst | ||
| http_101.rst | ||
| http_201.rst | ||
| identity_management.rst | ||
| index.rst | ||
| inits.rst | ||
| introduction.rst | ||
| kernel_tuning.rst | ||
| labs.rst | ||
| learning.rst | ||
| LICENSE | ||
| loadbalancing_101.rst | ||
| logs_101.rst | ||
| logs_201.rst | ||
| make.bat | ||
| Makefile | ||
| monitoring_101.rst | ||
| monitoring_201.rst | ||
| netbooting.rst | ||
| networking_101.rst | ||
| networking_201.rst | ||
| outages.rst | ||
| package_management_101.rst | ||
| postmortems.rst | ||
| programming_101.rst | ||
| programming_201.rst | ||
| reading_list.rst | ||
| README.md | ||
| remote_filesystems_101.rst | ||
| remote_filesystems_201.rst | ||
| requirements.txt | ||
| security_101.rst | ||
| security_201.rst | ||
| seealso.rst | ||
| shell_tools_101.rst | ||
| shells_101.rst | ||
| smtp_101.rst | ||
| smtp_201.rst | ||
| soft_skills_101.rst | ||
| soft_skills_201.rst | ||
| statistics.rst | ||
| stats_diagnosing.rst | ||
| sysadmin_101.rst | ||
| sysadmin_tools.rst | ||
| syscalls.rst | ||
| system_daemons_101.rst | ||
| text_editing_101.rst | ||
| text_editing_201.rst | ||
| troubleshooting_101.rst | ||
| unix_101.rst | ||
| unix_201.rst | ||
| unix_signals.rst | ||
| virtualization_101.rst | ||
| virtualization_201.rst | ||
| windows_101.rst | ||
Ops School Curriculum
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 project is written in reStructuredText
- Hosted by Read the Docs
- Tested by rendering in Sphinx on Travis CI
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_themeorpip install -r requirements.txt - Fork the
opsschool/curriculumrepository to your own account - Check out a branch to make your changes on:
git checkout --branch <my_topic> - Execute
make htmlto build the docs in to_build/ - Make your changes
- Execute
make htmlagain 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-commoncontains 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.
