-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdoc-mgmt.html
More file actions
155 lines (143 loc) · 6.5 KB
/
doc-mgmt.html
File metadata and controls
155 lines (143 loc) · 6.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
<!DOCTYPE HTML>
<!--
Phantom by HTML5 UP
html5up.net | @ajlkn
Free for personal and commercial use under the CCA 3.0 license (html5up.net/license)
-->
<html>
<head>
<title>About 101101</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no" />
<link rel="stylesheet" href="assets/css/main.css" />
<noscript><link rel="stylesheet" href="assets/css/noscript.css" /></noscript>
</head>
<body class="is-preload">
<!-- Wrapper -->
<div id="wrapper">
<!-- Header -->
<header id="header">
<div class="inner">
<!-- Logo -->
<a href="index.html" class="logo">
<span class="symbol"><img src="images/nu11.svg" alt="" /></span><span class="title">KB - a document management solution</span>
</a>
<!-- Nav -->
<nav>
<ul>
<li><a href="#menu">Menu</a></li>
</ul>
</nav>
</div>
</header>
<!-- Menu -->
<nav id="menu">
<h2>Menu</h2>
<ul>
<li><a href="index.html">Home</a></li>
<!--
<li><a href="generic.html">Ipsum veroeros</a></li>
<li><a href="generic.html">Tempus etiam</a></li>
<li><a href="generic.html">Consequat dolor</a></li>
<li><a href="elements.html">Elements</a></li>
-->
</ul>
</nav>
<!-- Main -->
<div id="main">
<div class="inner">
<!-- Main Content -->
<section>
<header>
<h2>Problem:</h2>
<h3>Enable migration out of the current Document Management solution, if it makes sense from a fiscal and labor perspective - </h3>
</header>
<hr>
<div class="row">
<div class="col-8 col-12-medium">
<p>
<h3>Description: </h3>
The document management solution that we had was "big," it cost a lot of money, and we didn't have a need to leverage more than ~40% of its capability. We often found ourselves questioning why we continued use it... Oh yeah, we were "locked in."
</p>
<p>
We wanted to find a solution which <u>cost less</u>, was fairly <u>simple to use</u>, had <u>version control</u>, <u>integrated</u> with our existing systems, and could be used for runbooks and other knowledge articles in response to alerts from our monitoring systems; bonus points if it was able to be <u>directly linked</u> from alerts or notifications.
</p>
</div>
<div class="col-3 col-12-medium">
<h3>Check it out:</h3>
<a href="https://101101.github.io/kb" class="bordered-feature-image"><img src="https://dsmith73.github.io/images/101101.jpg" style="height:100px;width:250px;" alt="Demo" /></a>
<!-- <a href="https://101101.github.io/kb">Check-out the pilot site</a>
-->
</div>
</div>
<hr>
<p>
<h3>What did we do? </h3>
I looked at several other document management systems, and while nearly all of them were cheaper, they all still required more complexity than I thought we needed to achieve the goal.
</p>
<p>
Then I started thinking... GitHub has version control, it's accessible via API, you can run queries against it, and the only different in document formatting was a move to Markdown, which most of us were already embracing with code documentation. And the best part? It's a solution we're already paying for... so, it was essentially "free."
</p>
<p>
So, I searched a bit for a snazzy front-end to put on it (<a href="https://github.com/vsoch/docsy-jekyll">docsy-jeckyll</a>), modified the backend code to fit our document structure, and setup a pilot.
</p>
<hr>
<p>
<h3>What was the outcome? </h3>
The pilot was an immense success!
<ol>
<li>- We were able to send alerts with variable direct links to runbooks, or send variable links that would perform searches for runbooks</li>
<li>- The cost was $0 and the savings of not renewing our other document solution was tens of thousands</li>
<li>- It was simple to use, since we already used Markdown</li>
<li>- It is version controlled</li>
<li>- We can easily integrate it with other solutions since it lives in GitHub </li>
</ol>
</p>
<hr>
<!--
<p>
<h3>What are the benefits? </h3>
Unfortunately, we'd missed a 1 or a 0 <i>(or several)</i> somewhere, because the hose would blotch
out from time to time, and the exploding creatures were more like a pixelated blocks than the
expected KA-BOOM that we expected. But, the game worked! We played that thing for hours...
</p>
<hr>
-->
<p>
<h3>Any lessons learned? </h3>
Sometimes the simplest answers are the best ones.
</p>
</section>
</div>
</div>
<!-- Footer -->
<footer id="footer">
<div class="inner">
<section>
<h3>Follow</h3>
<ul class="icons">
<!--
<li><a href="#" class="icon brands style2 fa-twitter"><span class="label">Twitter</span></a></li>
<li><a href="#" class="icon brands style2 fa-facebook-f"><span class="label">Facebook</span></a></li>
<li><a href="#" class="icon brands style2 fa-instagram"><span class="label">Instagram</span></a></li>
<li><a href="#" class="icon brands style2 fa-dribbble"><span class="label">Dribbble</span></a></li>
-->
<li><a href="https://github.com/101101" class="fab fa-github"></a></li>
<li><a href="https://join.slack.com/t/101101workspace/shared_invite/zt-eyngfj2o-zWnBAo3JXcXSu~nEudvXgQ" class="fab fa-slack" size="5x"></a></li>
<li><a href="https://discord.gg/RmzVNzx" class="fab fa-discord" size="5x"></a></li>
</ul>
</section>
<ul class="copyright">
<li>© dsmith73 All rights reserved</li><li>Design: <a href="http://html5up.net">HTML5 UP</a></li>
</ul>
</div>
</footer>
</div>
<!-- Scripts -->
<script src="assets/js/jquery.min.js"></script>
<script src="assets/js/browser.min.js"></script>
<script src="assets/js/breakpoints.min.js"></script>
<script src="assets/js/util.js"></script>
<script src="assets/js/main.js"></script>
</body>
</html>