From 015fee66acec75dbb6e5b7d9a1a0c634b27ad97d Mon Sep 17 00:00:00 2001 From: Ravi Srinivasan <rsriniva@users.noreply.github.com> Date: Wed, 13 Feb 2019 08:11:17 +0100 Subject: [PATCH] Updates to exercise 3 after mac QA --- README.md | 25 +++++++++++++++++++++---- 1 files changed, 21 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index db904e2..d29b228 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,29 @@ # Red Hat Open Innovation Labs Enablement Materials -This repo will house all the slides and lab exercises for the Enablement course. It will also be used to track issues, features and new additions to the course. +This repo will house all the slides and lab exercises for the Enablement. It will also be used to track issues, features and new additions to the Enablement. +[Course Content](https://rht-labs.github.io/enablement-docs/#/) ## Slides -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 +Slides are currently only available on Red Hat's Google Drive (https://drive.google.com/open?id=1Rk0XAn2WjY-cVAhGbCNiL6EdiiS-hxbK). We are working on a solution to make this content more openly available. + +In the mean time, if you are unable to access the link above and would like to see some of the content, please contact the author. + ## 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. Add items to the sidebar on the homepage by updating the `_sidebar` + +To run and serve the docs +1. `npm i -g docsify-cli` +2. `cd exercises && docsify serve -p 8085 -P 35727` and open your browser to 8085 + +## Publishing +The `exercises` folder is served as the root of the gitpages site from master branch. To update the published content run: +1. `git checkout master` +2. `git subtree push --prefix exercises origin gh-pages` + ## Contributing & Issues -To contribute raise an issue and submit a PR to correspond to that feature. +For tracking of feature development and task management add the ZenHub plugin extension to [Chrome](https://chrome.google.com/webstore/detail/zenhub-for-github/ogcgkffhplmphkaahpmffcafajaocjbd) or [Firefox](https://www.zenhub.com/extension). +To contribute raise an issue and submit a PR to correspond to that feature. \ No newline at end of file -- Gitblit v1.9.3