Skip to content

Commit a98afbf

Browse files
committed
course initialized for hand-on lab
1 parent b23ee6d commit a98afbf

25 files changed

+15
-205
lines changed

README-TRAINING.md

-8
This file was deleted.

README.md

+4-56
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,8 @@
1-
## Getting started with a new training content repository
1+
# About this Training
22

3-
- Open the [course-starter-template](https://github.com/RedHatQuickCourses/course-starter-template)
3+
FIXME: Add short description about your training here.
44

5-
- Click on `Use This template` button and select `Create a new repository` option.
5+
# Objectives
66

7-
![use-this-template.png](./images/use-this-template.png)
7+
FIXME: Add here the list of objectives being covered in this training.
88

9-
- On `Create a new repository` page, Select the options as highlighted in the below image and then click `Create repository` button at the bottom of the page.
10-
11-
![create-new-repo.png](./images/create-new-repo.png)
12-
13-
- Clone this repository on your local system:
14-
```
15-
git clone git@github.com:RedHatQuickCourses/my-training-repository.git
16-
```
17-
NOTE: Use your repository url in the above command.
18-
19-
- Go in to the course repository directory and initialize the course.
20-
```
21-
cd my-training-repository/
22-
sh course-init.sh --type bfx --lab demo
23-
```
24-
NOTE: If you are using Mac, use *zsh* in place of *sh* in the above command.
25-
26-
Sample output:
27-
```
28-
Initializing my-training-repository . . . done
29-
30-
Please replace the specified strings in the files below and commit the changes before proceeding with the course development.
31-
antora.yml:title: REPLACE Course Title
32-
```
33-
34-
- Edit the files prompted by course initialization script.
35-
36-
- Commit the changes done by course initialization script and your manual edits.
37-
```
38-
git status
39-
git add -A; git commit -m "course initialization"
40-
git push origin main
41-
```
42-
43-
- Browse your git repository url
44-
45-
- On your github repo page, on left hand side pane, click on settings gear icon near `About` heading.
46-
47-
- Click `Use your GitHub Pages website` option to select (checked) it and then click `Save changes` button.
48-
49-
![github-pages-setting](./images/github-pages-setting.png)
50-
51-
- You should now see the link to access the rendered content within that same block.
52-
53-
![quickcourse-rendered-url](./images/quickcourse-rendered-url.png)
54-
55-
FIXME: highlight the relevant area on images.
56-
57-
**SEE ALSO**
58-
59-
- [Development using devspace](./DEVSPACE.md)
60-
- [Guideline for editing your content](./USAGEGUIDE.adoc)

antora-playbook.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
site:
2-
title: FIXME Course Title
3-
start_page: REPLACEREPONAME::index.adoc
2+
title: NetworkManager Keyfile
3+
start_page: networkmanager-keyfile::index.adoc
44

55
content:
66
sources:

antora.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
name: REPLACEREPONAME
2-
title: FIXME Course Title
1+
name: networkmanager-keyfile
2+
title: NetworkManager Keyfile
33
version: 1
44
nav:
55
- modules/ROOT/nav.adoc

course-init.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ execute_init()
4343
handle_lab
4444
REPONAME=$(basename `git rev-parse --show-toplevel`)
4545
echo -ne "Initializing $REPONAME . . . "
46-
sed -i "s/REPLACEREPONAME/${REPONAME}/g" *.* > /dev/null 2>&1
47-
sed -i "s/REPLACEREPONAME/${REPONAME}/g" supplemental-ui/partials/header-content.hbs > /dev/null 2>&1
46+
sed -i "s/networkmanager-keyfile/${REPONAME}/g" *.* > /dev/null 2>&1
47+
sed -i "s/networkmanager-keyfile/${REPONAME}/g" supplemental-ui/partials/header-content.hbs > /dev/null 2>&1
4848
echo -e "done"
4949

5050
mv -f README-TRAINING.md README.md

devfile.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
schemaVersion: 2.1.0
22
metadata:
3-
name: REPLACEREPONAME-dev
3+
name: networkmanager-keyfile-dev
44
displayName: RHODS Quick Course
55
description: RHODS Quick Course published using Antora
66
icon: https://nodejs.org/static/images/logos/nodejs-new-pantone-black.svg
@@ -12,10 +12,10 @@ metadata:
1212
language: JavaScript
1313
version: 2.1.1
1414
starterProjects:
15-
- name: REPLACEREPONAME-dev
15+
- name: networkmanager-keyfile-dev
1616
git:
1717
remotes:
18-
origin: 'https://github.com/RedHatTraining/REPLACEREPONAME.git'
18+
origin: 'https://github.com/RedHatTraining/networkmanager-keyfile.git'
1919
components:
2020
- name: runtime
2121
container:

modules.bfx/LABENV/nav.adoc

-1
This file was deleted.

modules.bfx/LABENV/pages/index-lab-demo.adoc

-3
This file was deleted.

modules.bfx/LABENV/pages/index-lab-other.adoc

-3
This file was deleted.

modules.bfx/LABENV/pages/index-lab-role.adoc

-3
This file was deleted.

modules.bfx/LABENV/pages/index.adoc

-3
This file was deleted.

modules.bfx/ROOT/nav.adoc

-1
This file was deleted.

modules.bfx/ROOT/pages/index.adoc

-12
This file was deleted.

modules.bfx/appendix/nav.adoc

-1
This file was deleted.

modules.bfx/appendix/pages/appendix.adoc

-3
This file was deleted.

modules.bfx/chapter1/nav.adoc

-3
This file was deleted.

modules.bfx/chapter1/pages/index.adoc

-21
This file was deleted.

modules.bfx/chapter1/pages/section1.adoc

-15
This file was deleted.

modules.bfx/chapter1/pages/section2.adoc

-35
This file was deleted.

modules.bfx/chapter2/nav.adoc

-3
This file was deleted.

modules.bfx/chapter2/pages/index.adoc

-17
This file was deleted.

modules.bfx/chapter2/pages/section1.adoc

-3
This file was deleted.

modules.bfx/chapter2/pages/section2.adoc

-3
This file was deleted.

modules/LABENV/pages/index.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
= Lab Environment
22

3-
FIXME: Instructions for accessing the lab environment for this hands-on based training.
3+
FIXME: Instructions for accessing the lab environment on the ROLE platform, for this hands-on based training.

supplemental-ui/partials/header-content.hbs

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
</div>
1212
<div id="topbar-nav" class="navbar-menu">
1313
<div class="navbar-end">
14-
<a class="navbar-item" href="https://github.com/RedHatQuickCourses/REPLACEREPONAME/issues" target="_blank">Report Issues</a>
14+
<a class="navbar-item" href="https://github.com/RedHatQuickCourses/networkmanager-keyfile/issues" target="_blank">Report Issues</a>
1515
</div>
1616
</div>
1717
</nav>

0 commit comments

Comments
 (0)