GitHub/school-of-sre
1
0
Fork 0
mirror of https://github.com/linkedin/school-of-sre synced 2026-01-20 15:38:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Deployed 6100c9a with MkDocs version: 1.1.2

Browse Source
This commit is contained in:
github-actions
2021-01-06 08:00:38 +00:00
parent 404bf4e35d
commit 44c490f0cf
68 changed files with 7365 additions and 1034 deletions
Download Patch File Download Diff File Expand all files Collapse all files

207
CONTRIBUTING/index.html
View File

@@ -10,7 +10,7 @@
<link rel="shortcut icon" href="../img/favicon.ico">
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-6.1.5">
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-6.2.3">
@@ -18,10 +18,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.21aed14c.min.css">
<link rel="stylesheet" href="../assets/stylesheets/main.3b61ea93.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.196e0c26.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.39b8e14a.min.css">
@@ -29,7 +29,7 @@
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
<style>body,input{font-family:"Roboto",-apple-system,BlinkMacSystemFont,Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono",SFMono-Regular,Consolas,Menlo,monospace}</style>
@@ -53,13 +53,14 @@
<body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#building-and-testing-locally" class="md-skip">
<a href="#contributing-guidelines" class="md-skip">
Skip to content
</a>
@@ -140,7 +141,8 @@
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
@@ -154,6 +156,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
Home
@@ -166,9 +169,13 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2" >
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2" >
<label class="md-nav__link" for="nav-2">
Fundamentals Series
<span class="md-nav__icon md-icon"></span>
@@ -186,9 +193,13 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2-1" type="checkbox" id="nav-2-1" >
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2-1" type="checkbox" id="nav-2-1" >
<label class="md-nav__link" for="nav-2-1">
Linux Basics
<span class="md-nav__icon md-icon"></span>
@@ -206,6 +217,7 @@
<li class="md-nav__item">
<a href="../linux_basics/intro/" class="md-nav__link">
Introduction
@@ -218,6 +230,7 @@
<li class="md-nav__item">
<a href="../linux_basics/command_line_basics/" class="md-nav__link">
Command Line Basics
@@ -230,6 +243,7 @@
<li class="md-nav__item">
<a href="../linux_basics/linux_server_administration/" class="md-nav__link">
Server Administration
@@ -242,6 +256,7 @@
<li class="md-nav__item">
<a href="../linux_basics/conclusion/" class="md-nav__link">
Conclusion
@@ -259,9 +274,13 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2-2" type="checkbox" id="nav-2-2" >
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2-2" type="checkbox" id="nav-2-2" >
<label class="md-nav__link" for="nav-2-2">
Git
<span class="md-nav__icon md-icon"></span>
@@ -279,6 +298,7 @@
<li class="md-nav__item">
<a href="../git/git-basics/" class="md-nav__link">
Git Basics
@@ -291,6 +311,7 @@
<li class="md-nav__item">
<a href="../git/branches/" class="md-nav__link">
Working With Branches
@@ -303,6 +324,7 @@
<li class="md-nav__item">
<a href="../git/github-hooks/" class="md-nav__link">
Github and Hooks
@@ -315,6 +337,7 @@
<li class="md-nav__item">
<a href="../git/conclusion/" class="md-nav__link">
Conclusion
@@ -332,9 +355,13 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2-3" type="checkbox" id="nav-2-3" >
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2-3" type="checkbox" id="nav-2-3" >
<label class="md-nav__link" for="nav-2-3">
Linux Networking
<span class="md-nav__icon md-icon"></span>
@@ -352,6 +379,7 @@
<li class="md-nav__item">
<a href="../linux_networking/intro/" class="md-nav__link">
Introduction
@@ -364,6 +392,7 @@
<li class="md-nav__item">
<a href="../linux_networking/dns/" class="md-nav__link">
DNS
@@ -376,6 +405,7 @@
<li class="md-nav__item">
<a href="../linux_networking/udp/" class="md-nav__link">
UDP
@@ -388,6 +418,7 @@
<li class="md-nav__item">
<a href="../linux_networking/http/" class="md-nav__link">
HTTP
@@ -400,6 +431,7 @@
<li class="md-nav__item">
<a href="../linux_networking/tcp/" class="md-nav__link">
TCP
@@ -412,6 +444,7 @@
<li class="md-nav__item">
<a href="../linux_networking/ipr/" class="md-nav__link">
Routing
@@ -424,6 +457,7 @@
<li class="md-nav__item">
<a href="../linux_networking/conclusion/" class="md-nav__link">
Conclusion
@@ -446,9 +480,13 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" >
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" >
<label class="md-nav__link" for="nav-3">
Python and Web
<span class="md-nav__icon md-icon"></span>
@@ -466,6 +504,7 @@
<li class="md-nav__item">
<a href="../python_web/intro/" class="md-nav__link">
Introduction
@@ -478,6 +517,7 @@
<li class="md-nav__item">
<a href="../python_web/python-concepts/" class="md-nav__link">
Some Python Concepts
@@ -490,6 +530,7 @@
<li class="md-nav__item">
<a href="../python_web/python-web-flask/" class="md-nav__link">
Python, Web and Flask
@@ -502,6 +543,7 @@
<li class="md-nav__item">
<a href="../python_web/url-shorten-app/" class="md-nav__link">
The URL Shortening App
@@ -514,6 +556,7 @@
<li class="md-nav__item">
<a href="../python_web/sre-conclusion/" class="md-nav__link">
Conclusion
@@ -531,9 +574,13 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4" >
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4" >
<label class="md-nav__link" for="nav-4">
Data
<span class="md-nav__icon md-icon"></span>
@@ -551,9 +598,13 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-4-1" type="checkbox" id="nav-4-1" >
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-4-1" type="checkbox" id="nav-4-1" >
<label class="md-nav__link" for="nav-4-1">
Relational Databases
<span class="md-nav__icon md-icon"></span>
@@ -571,6 +622,7 @@
<li class="md-nav__item">
<a href="../databases_sql/intro/" class="md-nav__link">
Introduction
@@ -583,6 +635,7 @@
<li class="md-nav__item">
<a href="../databases_sql/concepts/" class="md-nav__link">
Key Concepts
@@ -595,6 +648,7 @@
<li class="md-nav__item">
<a href="../databases_sql/mysql/" class="md-nav__link">
MySQL
@@ -607,6 +661,7 @@
<li class="md-nav__item">
<a href="../databases_sql/innodb/" class="md-nav__link">
InnoDB
@@ -619,6 +674,7 @@
<li class="md-nav__item">
<a href="../databases_sql/operations/" class="md-nav__link">
Operational Concepts
@@ -631,6 +687,7 @@
<li class="md-nav__item">
<a href="../databases_sql/lab/" class="md-nav__link">
Lab
@@ -643,6 +700,7 @@
<li class="md-nav__item">
<a href="../databases_sql/conclusion/" class="md-nav__link">
Conclusion
@@ -660,9 +718,13 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-4-2" type="checkbox" id="nav-4-2" >
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-4-2" type="checkbox" id="nav-4-2" >
<label class="md-nav__link" for="nav-4-2">
NoSQL
<span class="md-nav__icon md-icon"></span>
@@ -680,6 +742,7 @@
<li class="md-nav__item">
<a href="../databases_nosql/intro/" class="md-nav__link">
Introduction
@@ -692,6 +755,7 @@
<li class="md-nav__item">
<a href="../databases_nosql/key_concepts/" class="md-nav__link">
Key Concepts
@@ -704,6 +768,7 @@
<li class="md-nav__item">
<a href="../databases_nosql/further_reading/" class="md-nav__link">
Conclusion
@@ -721,9 +786,13 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-4-3" type="checkbox" id="nav-4-3" >
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-4-3" type="checkbox" id="nav-4-3" >
<label class="md-nav__link" for="nav-4-3">
Big Data
<span class="md-nav__icon md-icon"></span>
@@ -741,6 +810,7 @@
<li class="md-nav__item">
<a href="../big_data/intro/" class="md-nav__link">
Introduction
@@ -753,6 +823,7 @@
<li class="md-nav__item">
<a href="../big_data/evolution/" class="md-nav__link">
Evolution and Architecture of Hadoop
@@ -765,6 +836,7 @@
<li class="md-nav__item">
<a href="../big_data/tasks/" class="md-nav__link">
Conclusion
@@ -787,9 +859,13 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5" >
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5" >
<label class="md-nav__link" for="nav-5">
Systems Design
<span class="md-nav__icon md-icon"></span>
@@ -807,6 +883,7 @@
<li class="md-nav__item">
<a href="../systems_design/intro/" class="md-nav__link">
Introduction
@@ -819,6 +896,7 @@
<li class="md-nav__item">
<a href="../systems_design/scalability/" class="md-nav__link">
Scalability
@@ -831,6 +909,7 @@
<li class="md-nav__item">
<a href="../systems_design/availability/" class="md-nav__link">
Availability
@@ -843,6 +922,7 @@
<li class="md-nav__item">
<a href="../systems_design/fault-tolerance/" class="md-nav__link">
Fault Tolerance
@@ -855,6 +935,7 @@
<li class="md-nav__item">
<a href="../systems_design/conclusion/" class="md-nav__link">
Conclusion
@@ -872,9 +953,13 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6" >
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6" >
<label class="md-nav__link" for="nav-6">
Security
<span class="md-nav__icon md-icon"></span>
@@ -892,6 +977,7 @@
<li class="md-nav__item">
<a href="../security/intro/" class="md-nav__link">
Introduction
@@ -904,6 +990,7 @@
<li class="md-nav__item">
<a href="../security/fundamentals/" class="md-nav__link">
Fundamentals of Security
@@ -916,6 +1003,7 @@
<li class="md-nav__item">
<a href="../security/network_security/" class="md-nav__link">
Network Security
@@ -928,6 +1016,7 @@
<li class="md-nav__item">
<a href="../security/threats_attacks_defences/" class="md-nav__link">
Threat, Attacks & Defences
@@ -940,6 +1029,7 @@
<li class="md-nav__item">
<a href="../security/writing_secure_code/" class="md-nav__link">
Writing Secure code
@@ -952,6 +1042,7 @@
<li class="md-nav__item">
<a href="../security/conclusion/" class="md-nav__link">
Conclusion
@@ -968,6 +1059,7 @@
@@ -996,11 +1088,25 @@
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#contributing-guidelines" class="md-nav__link">
Contributing Guidelines
</a>
</li>
<li class="md-nav__item">
<a href="#building-and-testing-locally" class="md-nav__link">
Building and testing locally
</a>
</li>
<li class="md-nav__item">
<a href="#opening-a-pr" class="md-nav__link">
Opening a PR
</a>
</li>
</ul>
@@ -1010,6 +1116,19 @@
</li>
<li class="md-nav__item">
<a href="../CODE_OF_CONDUCT/" class="md-nav__link">
Code of Conduct
</a>
</li>
</ul>
</nav>
</div>
@@ -1017,7 +1136,8 @@
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
@@ -1031,11 +1151,25 @@
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#contributing-guidelines" class="md-nav__link">
Contributing Guidelines
</a>
</li>
<li class="md-nav__item">
<a href="#building-and-testing-locally" class="md-nav__link">
Building and testing locally
</a>
</li>
<li class="md-nav__item">
<a href="#opening-a-pr" class="md-nav__link">
Opening a PR
</a>
</li>
</ul>
@@ -1055,14 +1189,27 @@
<p>We realise that the initial content we created is just a starting point and our hope is that the community can help in the journey refining and extending the contents.</p>
<p>As a contributor, you represent that the content you submit is not plagiarised. By submitting the content, you (and, if applicable, your employer) are licensing the submitted content to LinkedIn and the open source community subject to the Creative Commons Attribution 4.0 International Public License.</p>
<p>We suggest to open an issue first and seek advice for your changes before submitting a pull request.</p>
<p><em>Repository URL</em>: <a href="https://github.com/linkedin/school-of-sre">https://github.com/linkedin/school-of-sre</a></p>
<h3 id="contributing-guidelines">Contributing Guidelines</h3>
<p>Ensure that you adhere to the following guidelines:</p>
<ul>
<li>Should be about principles and concepts that can be applied in any company or individual project. Do not focus on particular tools or tech stack(which usually change over time).</li>
<li>Adhere to the <a href="/school-of-sre/CODE_OF_CONDUCT/">Code of Conduct</a>.</li>
<li>Should be relevant to the roles and responsibilities of an SRE.</li>
<li>Should be locally tested (see steps for testing) and well formatted.</li>
<li>It is good practice to open an issue first and discuss your changes before submitting a pull request. This way, you can incorporate ideas from others before you even start.</li>
</ul>
<h3 id="building-and-testing-locally">Building and testing locally</h3>
<p>Run the following commands to build and view the site locally before opening a PR.</p>
<pre><code>pip install -r requirements.txt
<pre><code>python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
mkdocs build
mkdocs serve
</code></pre>
<h3 id="opening-a-pr">Opening a PR</h3>
<p>Follow the <a href="GitHub PR workflow">https://guides.github.com/introduction/flow/</a> for your contributions.</p>
<p>Fork this repo, create a feature branch, commit your changes and open a PR to this repo.</p>
@@ -1096,6 +1243,20 @@ mkdocs serve
</a>
<a href="../CODE_OF_CONDUCT/" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
<div class="md-footer-nav__title">
<div class="md-ellipsis">
<span class="md-footer-nav__direction">
Next
</span>
Code of Conduct
</div>
</div>
<div class="md-footer-nav__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
</div>
</a>
</nav>
</div>
@@ -1132,15 +1293,15 @@ mkdocs serve
</div>
<script src="../assets/javascripts/vendor.7e0ee788.min.js"></script>
<script src="../assets/javascripts/bundle.b3a72adc.min.js"></script><script id="__lang" type="application/json">{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}</script>
<script src="../assets/javascripts/vendor.08c56446.min.js"></script>
<script src="../assets/javascripts/bundle.6ced434e.min.js"></script><script id="__lang" type="application/json">{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}</script>
<script>
app = initialize({
base: "..",
features: [],
search: Object.assign({
worker: "../assets/javascripts/worker/search.4ac00218.min.js"
worker: "../assets/javascripts/worker/search.8c7e0a7e.min.js"
}, typeof search !== "undefined" && search)
})
</script>