Skip to content

Commit 5e98240

Browse files
committed
Update to abbreviations and glossary pages
Added abbreviations extentions and updated glossary page Signed-off-by: Scott McCarthy <scott.mccarthy@opencastsoftware.com>
1 parent d054e5f commit 5e98240

4 files changed

Lines changed: 23 additions & 11 deletions

File tree

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# DevOps Vs SRE
22

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

57
## Overview

docs/devops-basics/glossary.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1-
# DevOps Glossary
1+
---
2+
title: DevOps Glossary
3+
summary: A list of DevOps terms as defined by the DevOps Institute
24

3-
PLACEHOLDER
5+
---
6+
This list of DevOps terms as defined by the DevOps Institute
7+
8+
| Term | Definition |
9+
|---------------------------|---------------------------------------------------------------------------------------------------------------------------|
10+
| A/B Testing | Deploy different versions of an EUT to different customers and let the customer feedback determine which is best. |
11+
| Administration Testing | The purpose of the test is to determine if an End User Test (EUT) is able to process administration tasks as expected. |

includes/abbreviations.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
*[HTML]: Hyper Text Markup Language
2+
*[W3C]: World Wide Web Consortium

mkdocs.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#### SITE BASE CONFIG ###
1+
### SITE BASE CONFIG ###
22

33
# Default values, taken from mkdocs_theme.yml
44
site_name: Devops Docs
@@ -12,7 +12,7 @@ icon:
1212
logo: logo
1313
theme:
1414
name: material
15-
# custom_dir: overrides
15+
# custom_dir: overrides # Not currently used
1616

1717
features:
1818
# - navigation.instant
@@ -27,15 +27,15 @@ theme:
2727
include_search_page: false
2828
search_index_only: true
2929

30+
### START OF EXTENSIONS SECTION ###
31+
32+
markdown_extensions:
33+
- pymdownx.snippets:
34+
auto_append:
35+
- includes/abbreviations.md
3036

31-
#### START OF NAVIGATION SECTION ###
3237

33-
#nav:
34-
# - Section:
35-
# - section/index.md
36-
# - Page 1: section/page-1.md
37-
# ...
38-
# - Page n: section/page-n.md
38+
#### START OF NAVIGATION SECTION ###
3939

4040
nav:
4141
- Home: index.md

0 commit comments

Comments
 (0)