From c951f764aadd91eb4291ec60664f4c70e4a44c95 Mon Sep 17 00:00:00 2001
From: donal <donalspring@gmail.com>
Date: Wed, 04 Apr 2018 16:00:30 +0200
Subject: [PATCH] rework of the docsify template to have one template to rule them all
---
exercises/1-the-pbi-menace/README.md | 42 ++++++++++++++
exercises/0-docs-template/README.md | 6 +
exercises/2-attack-of-the-pipelines/_sidebar.md | 0
exercises/index.html | 5 +
exercises/7-the-cluster-awakens/_sidebar.md | 0
exercises/_sidebar.md | 9 +++
exercises/4-an-enslaved-hope/_sidebar.md | 0
exercises/6-return-of-the-app-monitoring/_sidebar.md | 0
exercises/8-the-last-demo-day/_sidebar.md | 0
exercises/README.md | 45 +++++++++++++++
exercises/images/new-item.png | 0
README.md | 4
exercises/0-docs-template/_sidebar.md | 0
exercises/.nojekyll | 0
exercises/3-revenge-of-the-automated-testing/_sidebar.md | 0
exercises/5-non-functionals-strike-back/_sidebar.md | 0
exercises/2-attack-of-the-pipelines/README.md | 42 ++++++++++++++
exercises/1-the-pbi-menace/_sidebar.md | 0
18 files changed, 147 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 1e63427..14df372 100644
--- a/README.md
+++ b/README.md
@@ -6,9 +6,9 @@
Use the [Open Innovation Labs reveal.js template](https://github.com/rht-labs/slides-template) to create new content. Add your slides and commit them to the `slides` dir
## Exercises
-Exercises are created using [Docsify](https://docsify.js.org/#/). Write docs in Markdown and use [Docsify](https://github.com/QingWei-Li/docsify-cli) cli to serve them. Store your lab exercises in the `exercises` dir.
+Exercises are created using [Docsify](https://docsify.js.org/#/). Write docs in Markdown and use [Docsify](https://github.com/QingWei-Li/docsify-cli) cli to serve them. Store your lab exercises in the `exercises/<lab-number>` dir.
-A template layout for the lab exercise with headings and what should be included is stored in `exercises/0-docs-template`. Use this as a base point when creating new materials
+A template layout for the lab exercise with headings and what should be included is stored in `exercises/0-docs-template`. Use this as a base point when creating new materials. Add items to the sidebar on the homepage by updating the `_sidebar`
## Contributing & Issues
To contribute raise an issue and submit a PR to correspond to that feature.
diff --git a/exercises/0-docs-template/.nojekyll b/exercises/.nojekyll
similarity index 100%
rename from exercises/0-docs-template/.nojekyll
rename to exercises/.nojekyll
diff --git a/exercises/0-docs-template/README.md b/exercises/0-docs-template/README.md
index 4eaf747..371b9b4 100644
--- a/exercises/0-docs-template/README.md
+++ b/exercises/0-docs-template/README.md
@@ -14,7 +14,6 @@
1. [Jenkins](https://jenkins.io/) - OpenSource build automation server; highly customisable through plugins
1. [Ansible]() - blah blah ...
-
## 10,000 Ft View
> This should contain the goal of the exercise; with enough information that advanced learners could use this to build the exercise without much guidance. The information here
@@ -39,4 +38,7 @@
- Do some other stuff
## Additional Reading
- > List of links or other reading that might be of use / reference for the exercise
+> List of links or other reading that might be of use / reference for the exercise
+
+## Slide links
+> link back to the deck for the supporting material
\ No newline at end of file
diff --git a/exercises/0-docs-template/.nojekyll b/exercises/0-docs-template/_sidebar.md
similarity index 100%
copy from exercises/0-docs-template/.nojekyll
copy to exercises/0-docs-template/_sidebar.md
diff --git a/exercises/1-the-pbi-menace/README.md b/exercises/1-the-pbi-menace/README.md
new file mode 100644
index 0000000..3f31d2e
--- /dev/null
+++ b/exercises/1-the-pbi-menace/README.md
@@ -0,0 +1,42 @@
+# The PBI Menace
+
+> In this lab; learners will use Ansible to drive automated provisioning of Projects, Access Control, Git, Jenkins and Nexus
+
+## Learning Outcomes
+As a learner you will be able to
+- Do thing 1
+- Do thing 2
+- Do thing 3
+
+## Tools and Frameworks
+> Name of tool - short description and link to docs or website
+
+1. [Jenkins](https://jenkins.io/) - OpenSource build automation server; highly customisable through plugins
+1. [Ansible]() - blah blah ...
+
+
+## 10,000 Ft View
+> This should contain the goal of the exercise; with enough information that advanced learners could use this to build the exercise without much guidance. The information here
+
+## Step by Step Instructions
+> This is a fairly structured guide with references to exact filenames and sections of text to be added. Include pictures and code snippets where appropriate. Rule of thumb is learners are dumb.... so over describe _why_ we're doing things
+
+### Part 1 - do some things
+2. Do thing using tool X.
+2. Insert blah into `file1.txt`
+```
+export SOME_THING=biscuits
+```
+2. Open console and navigate to `New Item` and click it 
+
+### Part 2 - do some other things
+3. Do other things
+
+## Extension Tasks
+> Ideas for go-getters. Advanced topic for doers to get on with if they finish early. These will usually not have a solution and are provided for additional scope.
+
+ - Add Auth to your application
+ - Do some other stuff
+
+## Additional Reading
+ > List of links or other reading that might be of use / reference for the exercise
diff --git a/exercises/1-the-pbi-menace/.gitkeep b/exercises/1-the-pbi-menace/_sidebar.md
similarity index 100%
rename from exercises/1-the-pbi-menace/.gitkeep
rename to exercises/1-the-pbi-menace/_sidebar.md
diff --git a/exercises/2-attack-of-the-pipelines/README.md b/exercises/2-attack-of-the-pipelines/README.md
new file mode 100644
index 0000000..4eaf747
--- /dev/null
+++ b/exercises/2-attack-of-the-pipelines/README.md
@@ -0,0 +1,42 @@
+# Exercise Title
+
+> Short description of the exercise and it's outcomes
+
+## Learning Outcomes
+As a learner you will be able to
+- Do thing 1
+- Do thing 2
+- Do thing 3
+
+## Tools and Frameworks
+> Name of tool - short description and link to docs or website
+
+1. [Jenkins](https://jenkins.io/) - OpenSource build automation server; highly customisable through plugins
+1. [Ansible]() - blah blah ...
+
+
+## 10,000 Ft View
+> This should contain the goal of the exercise; with enough information that advanced learners could use this to build the exercise without much guidance. The information here
+
+## Step by Step Instructions
+> This is a fairly structured guide with references to exact filenames and sections of text to be added. Include pictures and code snippets where appropriate. Rule of thumb is learners are dumb.... so over describe _why_ we're doing things
+
+### Part 1 - do some things
+2. Do thing using tool X.
+2. Insert blah into `file1.txt`
+```
+export SOME_THING=biscuits
+```
+2. Open console and navigate to `New Item` and click it 
+
+### Part 2 - do some other things
+3. Do other things
+
+## Extension Tasks
+> Ideas for go-getters. Advanced topic for doers to get on with if they finish early. These will usually not have a solution and are provided for additional scope.
+
+ - Add Auth to your application
+ - Do some other stuff
+
+## Additional Reading
+ > List of links or other reading that might be of use / reference for the exercise
diff --git a/exercises/2-attack-of-the-pipelines/.gitkeep b/exercises/2-attack-of-the-pipelines/_sidebar.md
similarity index 100%
rename from exercises/2-attack-of-the-pipelines/.gitkeep
rename to exercises/2-attack-of-the-pipelines/_sidebar.md
diff --git a/exercises/3-revenge-of-the-automated-testing/.gitkeep b/exercises/3-revenge-of-the-automated-testing/_sidebar.md
similarity index 100%
rename from exercises/3-revenge-of-the-automated-testing/.gitkeep
rename to exercises/3-revenge-of-the-automated-testing/_sidebar.md
diff --git a/exercises/4-an-enslaved-hope/.gitkeep b/exercises/4-an-enslaved-hope/_sidebar.md
similarity index 100%
rename from exercises/4-an-enslaved-hope/.gitkeep
rename to exercises/4-an-enslaved-hope/_sidebar.md
diff --git a/exercises/5-non-functionals-strike-back/.gitkeep b/exercises/5-non-functionals-strike-back/_sidebar.md
similarity index 100%
rename from exercises/5-non-functionals-strike-back/.gitkeep
rename to exercises/5-non-functionals-strike-back/_sidebar.md
diff --git a/exercises/6-return-of-the-app-monitoring/.gitkeep b/exercises/6-return-of-the-app-monitoring/_sidebar.md
similarity index 100%
rename from exercises/6-return-of-the-app-monitoring/.gitkeep
rename to exercises/6-return-of-the-app-monitoring/_sidebar.md
diff --git a/exercises/7-the-cluster-awakens/.gitkeep b/exercises/7-the-cluster-awakens/_sidebar.md
similarity index 100%
rename from exercises/7-the-cluster-awakens/.gitkeep
rename to exercises/7-the-cluster-awakens/_sidebar.md
diff --git a/exercises/8-the-last-demo-day/.gitkeep b/exercises/8-the-last-demo-day/_sidebar.md
similarity index 100%
rename from exercises/8-the-last-demo-day/.gitkeep
rename to exercises/8-the-last-demo-day/_sidebar.md
diff --git a/exercises/README.md b/exercises/README.md
new file mode 100644
index 0000000..ff25c28
--- /dev/null
+++ b/exercises/README.md
@@ -0,0 +1,45 @@
+Below is a template of what is needed for each lab. Use it as a starting point when creating lab specific content in each lab folder.
+______
+
+# Exercise Title
+
+> Short description of the exercise and it's outcomes
+
+## Learning Outcomes
+As a learner you will be able to
+- Do thing 1
+- Do thing 2
+- Do thing 3
+
+## Tools and Frameworks
+> Name of tool - short description and link to docs or website
+
+1. [Jenkins](https://jenkins.io/) - OpenSource build automation server; highly customisable through plugins
+1. [Ansible]() - blah blah ...
+
+
+## 10,000 Ft View
+> This should contain the goal of the exercise; with enough information that advanced learners could use this to build the exercise without much guidance. The information here
+
+## Step by Step Instructions
+> This is a fairly structured guide with references to exact filenames and sections of text to be added. Include pictures and code snippets where appropriate. Rule of thumb is learners are dumb.... so over describe _why_ we're doing things
+
+### Part 1 - do some things
+2. Do thing using tool X.
+2. Insert blah into `file1.txt`
+```
+export SOME_THING=biscuits
+```
+2. Open console and navigate to `New Item` and click it 
+
+### Part 2 - do some other things
+3. Do other things
+
+## Extension Tasks
+> Ideas for go-getters. Advanced topic for doers to get on with if they finish early. These will usually not have a solution and are provided for additional scope.
+
+ - Add Auth to your application
+ - Do some other stuff
+
+## Additional Reading
+ > List of links or other reading that might be of use / reference for the exercise
diff --git a/exercises/_sidebar.md b/exercises/_sidebar.md
new file mode 100644
index 0000000..044a285
--- /dev/null
+++ b/exercises/_sidebar.md
@@ -0,0 +1,9 @@
+* [Home](/)
+* [1. The PBI Menace](1-the-pbi-menace/README.md)
+* [2. Attack of the Pipelines](2-attack-of-the-pipelines/README.md)
+* [3. Revenge of the Automated Testing](3-revenge-of-the-automated-testing/README.md)
+* [4. An Enslaved Hope](4-an-enslaved-hope/README.md)
+* [5. The Non Functionals Strike Back](5-non-functionals-strike-back/README.md)
+* [6. Return of the Monitoring](6-return-of-the-app-monitoring/README.md)
+* [7. The Cluster Awakens](7-the-cluster-awakens/README.md)
+* [8. The Last Demo Day](8-the-last-demo-day/README.md)
diff --git a/exercises/0-docs-template/images/new-item.png b/exercises/images/new-item.png
similarity index 100%
rename from exercises/0-docs-template/images/new-item.png
rename to exercises/images/new-item.png
Binary files differ
diff --git a/exercises/0-docs-template/index.html b/exercises/index.html
similarity index 80%
rename from exercises/0-docs-template/index.html
rename to exercises/index.html
index e3eb7bf..5b0d615 100644
--- a/exercises/0-docs-template/index.html
+++ b/exercises/index.html
@@ -12,8 +12,9 @@
<div id="app"></div>
<script>
window.$docsify = {
- name: '',
- repo: ''
+ name: 'Red Hat Open Innovation Labs Exercises',
+ repo: 'https://github.com/rht-labs/enablement-docs',
+ loadSidebar: true
}
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
--
Gitblit v1.9.3