Skip to content

Commit 70d6b4b

Browse files
committed
playing around with some markdown extensions.
deleted: docs/SUMMARY.md deleted: docs/devops-basics/basics-overview.md modified: docs/devops-basics/devops-vs-sre.md modified: docs/devops-practices/practice-overview.md modified: mkdocs.yml Signed-off-by: Scott McCarthy <scott.mccarthy@opencastsoftware.com>
1 parent 5e98240 commit 70d6b4b

5 files changed

Lines changed: 36 additions & 51 deletions

File tree

docs/SUMMARY.md

Lines changed: 0 additions & 39 deletions
This file was deleted.

docs/devops-basics/basics-overview.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/devops-basics/devops-vs-sre.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# DevOps Vs SRE
22

3-
*[SRE]: Site Reliability Engineer
4-
53
_This article originated from a blog on [Harness's website](https://harness.io/blog/devops/sre-vs-devops/) - dated Nov 3, 2021_
64

75
## Overview
86

97
In a nutshell, DevOps Engineers are ops-focused engineers who solve development pipeline problems. Site Reliability Engineers are development-focused engineers who solve operational/scale/reliability problems.
108

11-
![devops overview](../img/sre-v-devops-1.png)
9+
<figure markdown>
10+
![devops overview](../img/sre-v-devops-1.png){ width="300" }
11+
<figcaption>Image caption</figcaption>
12+
</figure>
1213

1314
Software is certainly eating the world, and as our dependence on technology increases, disciplines have arisen to ensure that changes are rolled out efficiently and our systems are there when we need them. The rise of DevOps and Site Reliability Engineering cultures and practices has risen to the mainstream over the past years.
1415

docs/devops-practices/practice-overview.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,10 @@ Below you can learn more about each particular Devops best practice.
99
- Infrastructure as Code
1010
- Monitoring and Logging
1111
- Communication and Collaboration
12+
13+
<!--- Exmple of Image with caption
14+
#<figure markdown>
15+
# ![Image title](https://dummyimage.com/600x400/){ width="300" }
16+
# <figcaption>Image caption</figcaption>
17+
</figure>
18+
--->

mkdocs.yml

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,34 @@ theme:
2424
- navigation.indexes
2525

2626
# Necessary for search to work properly
27-
include_search_page: false
28-
search_index_only: true
27+
# include_search_page: false
28+
# search_index_only: true
2929

30-
### START OF EXTENSIONS SECTION ###
30+
### START OF EXTENSIONS & PLUGIN SECTION ###
3131

32+
33+
34+
# Used for glossary page and adding abbrviations
3235
markdown_extensions:
33-
- pymdownx.snippets:
34-
auto_append:
35-
- includes/abbreviations.md
36+
- pymdownx.snippets:
37+
auto_append:
38+
- includes/abbreviations.md
39+
40+
# used for Images and adding inline captions
41+
markdown_extensions:
42+
- attr_list
43+
- md_in_html
44+
45+
plugins:
46+
- glightbox
47+
48+
# Used for tasklists and adding checkboxes to pages
49+
markdown_extensions:
50+
- def_list
51+
- pymdownx.tasklist:
52+
custom_checkbox: true
53+
54+
3655

3756

3857
#### START OF NAVIGATION SECTION ###

0 commit comments

Comments
 (0)