diff --git a/README-TRAINING.md b/README-TRAINING.md deleted file mode 100644 index a427c82..0000000 --- a/README-TRAINING.md +++ /dev/null @@ -1,10 +0,0 @@ -# About this Training - -**Click here: [![Contribute](https://www.eclipse.org/che/contribute.svg)](https://devspaces.apps.tools-na100.dev.ole.redhat.com/#https://github.com/RedHatQuickCourses/REPLACEREPONAME) to start the development using devspace.** - -FIXME: Add short description about your training here. - -# Objectives - -FIXME: Add here the list of objectives being covered in this training. - diff --git a/README.md b/README.md index 6381b60..e8bfe64 100644 --- a/README.md +++ b/README.md @@ -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/test-hol) 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 git@github.com: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) diff --git a/antora-playbook.yml b/antora-playbook.yml index f9b8936..4a5bb50 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -1,6 +1,6 @@ site: - title: FIXME Course Title - start_page: REPLACEREPONAME::index.adoc + title: Test hand-on lab course + start_page: test-hol::index.adoc content: sources: diff --git a/antora.yml b/antora.yml index 5a11440..b238b3d 100644 --- a/antora.yml +++ b/antora.yml @@ -1,5 +1,5 @@ -name: REPLACEREPONAME -title: FIXME Course Title +name: test-hol +title: Test hand-on lab course version: 1 nav: - modules/ROOT/nav.adoc diff --git a/course-init.sh b/course-init.sh index f72ae4e..bec1638 100644 --- a/course-init.sh +++ b/course-init.sh @@ -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/test-hol/${REPONAME}/g" *.* > /dev/null 2>&1 + sed -i "s/test-hol/${REPONAME}/g" supplemental-ui/partials/header-content.hbs > /dev/null 2>&1 echo -e "done" mv -f README-TRAINING.md README.md diff --git a/devfile.yaml b/devfile.yaml index 7e8101b..fa94788 100644 --- a/devfile.yaml +++ b/devfile.yaml @@ -1,6 +1,6 @@ schemaVersion: 2.1.0 metadata: - name: REPLACEREPONAME-dev + name: test-hol-dev displayName: RHODS Quick Course description: RHODS Quick Course published using Antora icon: https://nodejs.org/static/images/logos/nodejs-new-pantone-black.svg @@ -12,10 +12,10 @@ metadata: language: JavaScript version: 2.1.1 starterProjects: - - name: REPLACEREPONAME-dev + - name: test-hol-dev git: remotes: - origin: 'https://github.com/RedHatTraining/REPLACEREPONAME.git' + origin: 'https://github.com/RedHatTraining/test-hol.git' components: - name: runtime container: diff --git a/modules.bfx/LABENV/nav.adoc b/modules.bfx/LABENV/nav.adoc deleted file mode 100644 index 31f850e..0000000 --- a/modules.bfx/LABENV/nav.adoc +++ /dev/null @@ -1 +0,0 @@ -* xref:index.adoc[] diff --git a/modules.bfx/LABENV/pages/index-lab-demo.adoc b/modules.bfx/LABENV/pages/index-lab-demo.adoc deleted file mode 100644 index 5b6cb08..0000000 --- a/modules.bfx/LABENV/pages/index-lab-demo.adoc +++ /dev/null @@ -1,27 +0,0 @@ -= Lab Environment - -== 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] - diff --git a/modules.bfx/LABENV/pages/index-lab-other.adoc b/modules.bfx/LABENV/pages/index-lab-other.adoc deleted file mode 100644 index 495937c..0000000 --- a/modules.bfx/LABENV/pages/index-lab-other.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Lab Environment - -FIXME: Instructions for accessing the lab environment on any other platform, for this hands-on based training. \ No newline at end of file diff --git a/modules.bfx/LABENV/pages/index-lab-role.adoc b/modules.bfx/LABENV/pages/index-lab-role.adoc deleted file mode 100644 index 2832f7c..0000000 --- a/modules.bfx/LABENV/pages/index-lab-role.adoc +++ /dev/null @@ -1,17 +0,0 @@ -= Lab Environment - -== Instructions to Launch Your Lab on the Red Hat Online Learning (ROLE) Platform - -. **Log in** to the xref:#ROLE-Portal-Links[ROLE platform] -. **Search** for the catalog entry: **FIXME Lab Catalog Name**. -. **Click** on the **Launch** button for the catalog entry in the search results. -. On the Course page, **click** the **Lab Environment** tab. -. Click on the **Create** button on the Lab Environment page to launch the lab. -. Wait for the lab creation process to complete. -. When the lab is created, refer to the **SSH Private Key & Instructions** on the page to access your lab. - -[[ROLE-Portal-Links]] -=== ROLE Portal Links -- RedHat associates: https://role.rhu.redhat.com/rol-rhu/app/[https://role.rhu.redhat.com/rol-rhu/app/,window=_blank] -- RedHat partners: https://rol.redhat.com/rol/app[https://rol.redhat.com/rol/app,window=_blank] - diff --git a/modules.bfx/LABENV/pages/index.adoc b/modules.bfx/LABENV/pages/index.adoc deleted file mode 100644 index b0d7c64..0000000 --- a/modules.bfx/LABENV/pages/index.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Lab Environment - -FIXME: Instructions for accessing the lab environment on the Demo platform, for this hands-on based training. \ No newline at end of file diff --git a/modules.bfx/ROOT/nav.adoc b/modules.bfx/ROOT/nav.adoc deleted file mode 100644 index 31f850e..0000000 --- a/modules.bfx/ROOT/nav.adoc +++ /dev/null @@ -1 +0,0 @@ -* xref:index.adoc[] diff --git a/modules.bfx/ROOT/pages/index.adoc b/modules.bfx/ROOT/pages/index.adoc deleted file mode 100644 index 67c6b66..0000000 --- a/modules.bfx/ROOT/pages/index.adoc +++ /dev/null @@ -1,12 +0,0 @@ -= An Example Break-fix course -:navtitle: Home - -== Introduction - -TITLE1: Red Hat Enterprise Linux 9 (FIXME product) - -TITLE2: Break-fix Practice 1 (FIXME title) - -Description: -This break-fix training simulates a problem FIXME . You'll investigate and solve the problem in a hands-on lab environment to complete the training. - diff --git a/modules.bfx/appendix/nav.adoc b/modules.bfx/appendix/nav.adoc deleted file mode 100644 index 92a20a7..0000000 --- a/modules.bfx/appendix/nav.adoc +++ /dev/null @@ -1 +0,0 @@ -* xref:appendix.adoc[] \ No newline at end of file diff --git a/modules.bfx/appendix/pages/appendix.adoc b/modules.bfx/appendix/pages/appendix.adoc deleted file mode 100644 index 20ff6f1..0000000 --- a/modules.bfx/appendix/pages/appendix.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Appendix - -Content for Appendix... \ No newline at end of file diff --git a/modules.bfx/chapter1/nav.adoc b/modules.bfx/chapter1/nav.adoc deleted file mode 100644 index ba712ee..0000000 --- a/modules.bfx/chapter1/nav.adoc +++ /dev/null @@ -1,3 +0,0 @@ -* xref:index.adoc[] -** xref:section1.adoc[] -** xref:section2.adoc[] diff --git a/modules.bfx/chapter1/pages/index.adoc b/modules.bfx/chapter1/pages/index.adoc deleted file mode 100644 index dd7092e..0000000 --- a/modules.bfx/chapter1/pages/index.adoc +++ /dev/null @@ -1,21 +0,0 @@ -= What’s in this break-fix? - -== In this break-fix: - -**Type of issue:** - -FIXME: Describe an issue type/category that this specific issue falls into, like, "A Red Hat Enterprise Linux 7 system won't boot after a kernel update." Save issue-specific details for the break-fix scenario page. - - - -**What you should already know:** - -FIXME: This training assumes that you are a Red Hat Certified System Administrator (RHCSA) or have equivalent experience administrating Red Hat Enterprise Linux 7 or 8. FIXME - update this as needed - - -**How break-fix training works:** - -. Challenge yourself in the break-fix activity. It describes a problem scenario that's simulated in the lab environment where you can investigate and solve the problem. -. Follow up with the guided solution: -.. If you weren't able to solve the problem on your own, read and follow the instructions in the Guided Solution to complete this training. -.. If you were successful in solving the problem, read the solution for useful tips you can apply when solving similar problems. \ No newline at end of file diff --git a/modules.bfx/chapter1/pages/section1.adoc b/modules.bfx/chapter1/pages/section1.adoc deleted file mode 100644 index 7608ef9..0000000 --- a/modules.bfx/chapter1/pages/section1.adoc +++ /dev/null @@ -1,15 +0,0 @@ -= Break-fix activity - -This section presents a scenario based on a real customer issue. - -. Read the scenario and success criteria. -. Follow any instructions provided for setting up your lab environment. -. Resolve the issue as simulated in your lab environment. -. After resolving the issue, run the grading script and submit the completion code as prompted. - - -**You must successfully complete this section to receive a passing grade for this module.** - - -If you exhaust your experience and resources, and you're unable to solve the issue on your own, use the guided solution to step through one possible solution, with tips for addressing similar issues. - diff --git a/modules.bfx/chapter1/pages/section2.adoc b/modules.bfx/chapter1/pages/section2.adoc deleted file mode 100644 index 2ee0449..0000000 --- a/modules.bfx/chapter1/pages/section2.adoc +++ /dev/null @@ -1,35 +0,0 @@ -= Check your work - -== Follow below steps in the lab to check your work - -FIXME: Add the instructions to be followed in the lab environment to make sure the problem has been resolved. You may chose to remove this block if grading script is provided in the lab to check the work. - -== Check your work using the grading script - -After you have resolved the issue and met the success criteria, login to `FIXME` system as `FIXME` user and run the grading script as shown here to check your work: - -[source,bash,role=execute] ----- -break-fix-script grade ----- - -.Sample output ----- -[root@classroom ~]# break-fix-script grade -Initiating break-fix-script with option grade -Grading. Please wait. -Success. -COMPLETION CODE: -Completed break-fix-script with option grade successfully ----- - -FIXME: Remove the below block if no grading script is provided to check the work in the break-fix activity. In this case make sure you use the above block to provide step-by-step instructions learner can follow to check their work. - -== Submit the completion code - -NOTE: Skip this if not applicable for you. - -- For RedHat internal audience: Submit that completion code https://link-to-appropriate-lms.com[here,window=_blank] to receive a grade for this training -- For RedHat partners: Submit that completion code https://link-to-appropriate-lms.com[here,window=_blank] to receive a grade for this training - -FIXME: Change the links in the above lines to the link for appropriate audience specific LMS where learner can provide completion code. Remove this block if submitting completion is not applicable. \ No newline at end of file diff --git a/modules.bfx/chapter2/nav.adoc b/modules.bfx/chapter2/nav.adoc deleted file mode 100644 index d6da93d..0000000 --- a/modules.bfx/chapter2/nav.adoc +++ /dev/null @@ -1,3 +0,0 @@ -* xref:index.adoc[] -** xref:section1.adoc[] -** xref:section2.adoc[] \ No newline at end of file diff --git a/modules.bfx/chapter2/pages/index.adoc b/modules.bfx/chapter2/pages/index.adoc deleted file mode 100644 index 0bcebd8..0000000 --- a/modules.bfx/chapter2/pages/index.adoc +++ /dev/null @@ -1,17 +0,0 @@ -= Guided solution - -This section presents a guided solution to the break-fix activity. - -Use this section to: - -Learn one possible path to resolving the issue. - -Get some tips for investigating and resolving similar issues. - - -If you're still stuck after exhausting your expertise and resources on the break-fix activity: - -Use this solution to complete the activity. -Check your work when you finish to receive a grade for this activity. - -NOTE: The steps detailed in these solution pages are optional. They provide additional guidance for those struggling with the break-fix activity. We encourage you to only use these pages if you are completely stuck in solving the issue diff --git a/modules.bfx/chapter2/pages/section1.adoc b/modules.bfx/chapter2/pages/section1.adoc deleted file mode 100644 index 4348b61..0000000 --- a/modules.bfx/chapter2/pages/section1.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Guided solution (page 1 of 2) - -FIXME: Provide step-by-step instructions here to resolve the issue. \ No newline at end of file diff --git a/modules.bfx/chapter2/pages/section2.adoc b/modules.bfx/chapter2/pages/section2.adoc deleted file mode 100644 index ce009a5..0000000 --- a/modules.bfx/chapter2/pages/section2.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Guided solution (page 2 of 2) - -FIXME: Provide step-by-step instructions here to resolve the issue. \ No newline at end of file diff --git a/modules/LABENV/pages/index.adoc b/modules/LABENV/pages/index.adoc index 6917afa..2832f7c 100644 --- a/modules/LABENV/pages/index.adoc +++ b/modules/LABENV/pages/index.adoc @@ -1,3 +1,17 @@ = Lab Environment -FIXME: Instructions for accessing the lab environment for this hands-on based training. \ No newline at end of file +== Instructions to Launch Your Lab on the Red Hat Online Learning (ROLE) Platform + +. **Log in** to the xref:#ROLE-Portal-Links[ROLE platform] +. **Search** for the catalog entry: **FIXME Lab Catalog Name**. +. **Click** on the **Launch** button for the catalog entry in the search results. +. On the Course page, **click** the **Lab Environment** tab. +. Click on the **Create** button on the Lab Environment page to launch the lab. +. Wait for the lab creation process to complete. +. When the lab is created, refer to the **SSH Private Key & Instructions** on the page to access your lab. + +[[ROLE-Portal-Links]] +=== ROLE Portal Links +- RedHat associates: https://role.rhu.redhat.com/rol-rhu/app/[https://role.rhu.redhat.com/rol-rhu/app/,window=_blank] +- RedHat partners: https://rol.redhat.com/rol/app[https://rol.redhat.com/rol/app,window=_blank] + diff --git a/supplemental-ui/partials/header-content.hbs b/supplemental-ui/partials/header-content.hbs index 67bf13a..9f5f718 100644 --- a/supplemental-ui/partials/header-content.hbs +++ b/supplemental-ui/partials/header-content.hbs @@ -11,7 +11,7 @@