diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000..172bedb Binary files /dev/null and b/.DS_Store differ diff --git a/images/quick-course-structure.jpg b/images/quick-course-structure.jpg new file mode 100644 index 0000000..8314ab3 Binary files /dev/null and b/images/quick-course-structure.jpg differ diff --git a/modules/.DS_Store b/modules/.DS_Store new file mode 100644 index 0000000..c23cebf Binary files /dev/null and b/modules/.DS_Store differ diff --git a/modules/quickcourse/.DS_Store b/modules/quickcourse/.DS_Store new file mode 100644 index 0000000..b75fea6 Binary files /dev/null and b/modules/quickcourse/.DS_Store differ diff --git a/modules/quickcourse/images/qc-structure.jpg b/modules/quickcourse/images/qc-structure.jpg new file mode 100644 index 0000000..9395a9a Binary files /dev/null and b/modules/quickcourse/images/qc-structure.jpg differ diff --git a/modules/quickcourse/pages/section3.adoc b/modules/quickcourse/pages/section3.adoc index f4a7fa0..974b453 100644 --- a/modules/quickcourse/pages/section3.adoc +++ b/modules/quickcourse/pages/section3.adoc @@ -1,6 +1,6 @@ = Quick course content format guide -FIXME: Add instructions for formatting content using Chapters and Sections with antora.yml and nav.adoc +image::quick-course-structure.jpg[] See xref:references:asciidocqrg.adoc[Asciidoc quick reference guide] for help with drafting of your content. diff --git a/modules/references/.DS_Store b/modules/references/.DS_Store new file mode 100644 index 0000000..6a59370 Binary files /dev/null and b/modules/references/.DS_Store differ diff --git a/modules/references/images/audio-file.wav b/modules/references/images/audio-file.wav new file mode 100644 index 0000000..3179e0e Binary files /dev/null and b/modules/references/images/audio-file.wav differ diff --git a/modules/references/images/red-hat-logo.jpeg b/modules/references/images/red-hat-logo.jpeg new file mode 100644 index 0000000..b7ec86e Binary files /dev/null and b/modules/references/images/red-hat-logo.jpeg differ diff --git a/modules/references/images/video-file.mp4 b/modules/references/images/video-file.mp4 new file mode 100644 index 0000000..c6727c0 Binary files /dev/null and b/modules/references/images/video-file.mp4 differ diff --git a/modules/references/pages/asciidocqrg.adoc b/modules/references/pages/asciidocqrg.adoc index 49b5a4f..2dd2cb5 100644 --- a/modules/references/pages/asciidocqrg.adoc +++ b/modules/references/pages/asciidocqrg.adoc @@ -201,7 +201,7 @@ CAUTION: Highlighted text for Caution Callout == MEDIA -To render an image on the page, copy the image into the `modules/chapterN/images` directory and reference it by filename. +To render an image on the page, copy the required image in `modules/chapterN/images` directory and reference it as below. ---- image::sample-image.png[] ---- @@ -210,7 +210,7 @@ Example: image::sample-image.png[] -Use below syntax to use audio file on your content +Audio files also go into the `chapter/images` directory and are referenced as below. ---- audio::audio-file.wav[] ---- @@ -219,7 +219,7 @@ Example: audio::audio-file.wav[] -Use below syntax to render a video file on your content page. +Video files also go into the `chapter/images` directory and are referenced as below. ---- video::video-file.mp4[] ---- @@ -228,7 +228,6 @@ Example: video::video-file.mp4[] -FIXME: Add sample image, audio and video files. == TABLES diff --git a/modules/references/pages/glossary.adoc b/modules/references/pages/glossary.adoc index 2903680..72a41b5 100644 --- a/modules/references/pages/glossary.adoc +++ b/modules/references/pages/glossary.adoc @@ -1,40 +1,38 @@ = Glossary -Below is a brief description of a few key terminologies used in this developer guide. +Here are some key terminologies used in this developer guide (not in alphabetical order): -*OpenTraining:* +*OpenTraining* -OpenTraining is a program that enables subject matter experts (SMEs) within the organization to share their knowledge and expertise both internally and externally. SMEs use the tools and processes provided by the training team to create hands-on technical training content. After the SME develops the content, the training team performs testing and quality checks on the labs and materials, ensuring a smooth and rapid onboarding of the training. +OpenTraining is a program that enables subject matter experts (SMEs) within the organization to share their knowledge and expertise both internally and externally. SMEs use the tools and processes provided by the training team to create training content. After the SME develops the content, the training team performs testing and quality checks on the labs and materials, and helps publish the content, ensuring a smooth and rapid onboarding of the training. -*RedHat QuickCourse:* +*Red Hat QuickCourse* -RedHat QuickCourse is an Asciidoctor documentation toolchain built on the https://antora.org/[Antora project,window=_blank]. RedHat employees can collaborate with the training team to utilize the https://github.com/orgs/RedHatQuickCourses/repositories[GitHub repositories under this project,window=_blank] for content development. +Red Hat QuickCourse is an Asciidoctor documentation toolchain built on the https://antora.org/[Antora project,window=_blank]. Red Hat employees can collaborate with the training team to utilize the https://github.com/orgs/Red HatQuickCourses/repositories[GitHub repositories under this project,window=_blank] for content development. [[Know-It]] -*Know-It:* +*Know-It* An informational, blog-style learning experience. This format delivers concise, easily digestible content that focuses on providing key insights and practical knowledge allowing learners to quickly get up to speed on specific topics. [[How-To]] -*How-To:* +*How-To* +======= -A hands-on, lab-based learning experience designed to guide learners through practical tasks step by step. This format emphasizes active participation, allowing learners to apply their knowledge in real-time scenarios. +A hands-on, lab-based learning experience designed to guide learners through practical tasks step-by-step. This format emphasizes active participation, allowing learners to apply their knowledge in real-time scenarios. [[Break-Fix]] -*Break-Fix:* +*Break-Fix* A lab-based learning experience that challenges learners to solve real-world problems. Designed like a puzzle, this format presents learners with scenarios where something has gone wrong, and their task is to diagnose and fix the issue. [[RHDP]] -*RHDP labs:* +*RHDP labs* https://demo.redhat.com/[RHDP (Red Hat Demo Platform),window=_blank] is a lab environment offering provided by Red Hat for its associates and partners. The lab environments on this platform are built using the https://redhat-cop.github.io/agnosticd/[AgnosticD,window=_blank] project, an Ansible-based deployment tool for multiple cloud environments. -For more information on using this lab for your training, please refer to the xref:lab:rhdp.adoc[Lab Infrastructure Guide for RHDP]. - - [[ROLE]] -*ROLE labs:* +*ROLE labs* https://role.rhu.redhat.com/[ROLE (Red Hat Online Learning),window=_blank] is a lab environment offering provided by Red Hat for its associates and partners. This platform is primarily used for Red Hat certification courses and other shorter training programs offered by Red Hat.