Skip to content

Commit

Permalink
Course initialization
Browse files Browse the repository at this point in the history
  • Loading branch information
Amrinder Singh committed Nov 27, 2024
1 parent 86cd462 commit 0df862b
Show file tree
Hide file tree
Showing 25 changed files with 40 additions and 244 deletions.
10 changes: 0 additions & 10 deletions README-TRAINING.md

This file was deleted.

60 changes: 5 additions & 55 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,10 @@
## Getting started with a new training content repository
# About this Training

- Open the [course-starter-template](https://github.com/RedHatQuickCourses/course-starter-template)
**Click here: [![Contribute](https://www.eclipse.org/che/contribute.svg)](https://devspaces.apps.tools-na100.dev.ole.redhat.com/#https://github.com/RedHatQuickCourses/awx-aap-migration) to start the development using devspace.**

- Click on `Use This template` button and select `Create a new repository` option.
FIXME: Add short description about your training here.

![use-this-template.png](./images/use-this-template.png)
# Objectives

- 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.
FIXME: Add here the list of objectives being covered in this training.

![create-new-repo.png](./images/create-new-repo.png)

- Clone this repository on your local system:
```
git clone [email protected]:RedHatQuickCourses/my-training-repository.git
```
NOTE: Use your repository url in the above command.

- Go in to the course repository directory and initialize the course.
```
cd my-training-repository/
sh course-init.sh --type bfx --lab demo
```
NOTE: If you are using Mac, use *zsh* in place of *sh* in the above command.

Sample output:
```
Initializing my-training-repository . . . done
Please replace the specified strings in the files below and commit the changes before proceeding with the course development.
antora.yml:title: REPLACE Course Title
```

- Edit the files prompted by course initialization script.

- Commit the changes done by course initialization script and your manual edits.
```
git status
git add -A; git commit -m "course initialization"
git push origin main
```

- Browse your git repository url

- On your github repo page, on left hand side pane, click on settings gear icon near `About` heading.

- Click `Use your GitHub Pages website` option to select (checked) it and then click `Save changes` button.

![github-pages-setting](./images/github-pages-setting.png)

- You should now see the link to access the rendered content within that same block.

![quickcourse-rendered-url](./images/quickcourse-rendered-url.png)

FIXME: highlight the relevant area on images.

**SEE ALSO**

- [Development using devspace](./DEVSPACE.md)
- [Guideline for editing your content](./USAGEGUIDE.adoc)
4 changes: 2 additions & 2 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
site:
title: FIXME Course Title
start_page: REPLACEREPONAME::index.adoc
title: "Ansible Web eXecutable (AWX) to Ansible Automation Platform 2.5 (AAP) Migration"
start_page: awx-aap-migration::index.adoc

content:
sources:
Expand Down
4 changes: 2 additions & 2 deletions antora.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: REPLACEREPONAME
title: FIXME Course Title
name: awx-aap-migration
title: "Ansible Web eXecutable (AWX) to Ansible Automation Platform 2.5 (AAP) Migration"
version: 1
nav:
- modules/ROOT/nav.adoc
Expand Down
4 changes: 2 additions & 2 deletions course-init.sh
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ execute_init()
handle_lab
REPONAME=$(basename `git rev-parse --show-toplevel`)
echo -ne "Initializing $REPONAME . . . "
sed -i "s/REPLACEREPONAME/${REPONAME}/g" *.* > /dev/null 2>&1
sed -i "s/REPLACEREPONAME/${REPONAME}/g" supplemental-ui/partials/header-content.hbs > /dev/null 2>&1
sed -i "s/awx-aap-migration/${REPONAME}/g" *.* > /dev/null 2>&1
sed -i "s/awx-aap-migration/${REPONAME}/g" supplemental-ui/partials/header-content.hbs > /dev/null 2>&1
echo -e "done"

mv -f README-TRAINING.md README.md
Expand Down
6 changes: 3 additions & 3 deletions devfile.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
schemaVersion: 2.1.0
metadata:
name: REPLACEREPONAME-dev
name: awx-aap-migration-dev
displayName: RHODS Quick Course
description: RHODS Quick Course published using Antora
icon: https://nodejs.org/static/images/logos/nodejs-new-pantone-black.svg
Expand All @@ -12,10 +12,10 @@ metadata:
language: JavaScript
version: 2.1.1
starterProjects:
- name: REPLACEREPONAME-dev
- name: awx-aap-migration-dev
git:
remotes:
origin: 'https://github.com/RedHatTraining/REPLACEREPONAME.git'
origin: 'https://github.com/RedHatTraining/awx-aap-migration.git'
components:
- name: runtime
container:
Expand Down
1 change: 0 additions & 1 deletion modules.bfx/LABENV/nav.adoc

This file was deleted.

27 changes: 0 additions & 27 deletions modules.bfx/LABENV/pages/index-lab-demo.adoc

This file was deleted.

3 changes: 0 additions & 3 deletions modules.bfx/LABENV/pages/index-lab-other.adoc

This file was deleted.

17 changes: 0 additions & 17 deletions modules.bfx/LABENV/pages/index-lab-role.adoc

This file was deleted.

3 changes: 0 additions & 3 deletions modules.bfx/LABENV/pages/index.adoc

This file was deleted.

1 change: 0 additions & 1 deletion modules.bfx/ROOT/nav.adoc

This file was deleted.

12 changes: 0 additions & 12 deletions modules.bfx/ROOT/pages/index.adoc

This file was deleted.

1 change: 0 additions & 1 deletion modules.bfx/appendix/nav.adoc

This file was deleted.

3 changes: 0 additions & 3 deletions modules.bfx/appendix/pages/appendix.adoc

This file was deleted.

3 changes: 0 additions & 3 deletions modules.bfx/chapter1/nav.adoc

This file was deleted.

21 changes: 0 additions & 21 deletions modules.bfx/chapter1/pages/index.adoc

This file was deleted.

15 changes: 0 additions & 15 deletions modules.bfx/chapter1/pages/section1.adoc

This file was deleted.

35 changes: 0 additions & 35 deletions modules.bfx/chapter1/pages/section2.adoc

This file was deleted.

3 changes: 0 additions & 3 deletions modules.bfx/chapter2/nav.adoc

This file was deleted.

17 changes: 0 additions & 17 deletions modules.bfx/chapter2/pages/index.adoc

This file was deleted.

3 changes: 0 additions & 3 deletions modules.bfx/chapter2/pages/section1.adoc

This file was deleted.

3 changes: 0 additions & 3 deletions modules.bfx/chapter2/pages/section2.adoc

This file was deleted.

26 changes: 25 additions & 1 deletion modules/LABENV/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
= Lab Environment

FIXME: Instructions for accessing the lab environment for this hands-on based training.
== Instructions to Launch Your Lab on the Red Hat Demo Platform (RHDP)

. **Log in** to the xref:#RHDP-Portal-Links[RHDP portal]
. **Search** for the catalog entry: **FIXME Lab Catalog Name**.
. **Click** on the catalog entry in the search results.
. On the catalog page, **click** the **Order** button.
. **Fill out** the required details in the order form.
. **Review the warning** at the bottom of the form and **check the box** labeled: +
*“I confirm that I understand the above warnings.”*
. **Click** the **Order** button to place your lab order.

=== Important Notes:
- This lab may take approximately **FIXME minutes** to become ready.
- You will receive an **email with access details** once your lab environment is ready.
- You can also **retrieve lab access** directly from the RHDP portal.

=== How to Access Your Lab via the RHDP Portal:
. On the RHDP portal, **click** on the **Services** option in the left-hand menu.
. **Select your lab** from the listings on the right-hand side of the page to view access details.

[[RHDP-Portal-Links]]
=== RHDP Portal Links
- RedHat associates: https://demo.redhat.com/[https://demo.redhat.com/,window=_blank]
- RedHat partners: https://partner.demo.redhat.com/[https://partner.demo.redhat.com/,window=_blank]

2 changes: 1 addition & 1 deletion supplemental-ui/partials/header-content.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
</div>
<div id="topbar-nav" class="navbar-menu">
<div class="navbar-end">
<a class="navbar-item" href="https://github.com/RedHatQuickCourses/REPLACEREPONAME/issues" target="_blank">Report Issues</a>
<a class="navbar-item" href="https://github.com/RedHatQuickCourses/awx-aap-migration/issues" target="_blank">Report Issues</a>
</div>
</div>
</nav>
Expand Down

0 comments on commit 0df862b

Please sign in to comment.