Skip to content

Update glossary.adoc #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .DS_Store
Binary file not shown.
Binary file added images/quick-course-structure.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/.DS_Store
Binary file not shown.
Binary file added modules/quickcourse/.DS_Store
Binary file not shown.
Binary file added modules/quickcourse/images/qc-structure.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion modules/quickcourse/pages/section3.adoc
Original file line number Diff line number Diff line change
@@ -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.

Binary file added modules/references/.DS_Store
Binary file not shown.
Binary file added modules/references/images/audio-file.wav
Binary file not shown.
Binary file added modules/references/images/red-hat-logo.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/references/images/video-file.mp4
Binary file not shown.
7 changes: 3 additions & 4 deletions modules/references/pages/asciidocqrg.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
----
Expand All @@ -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[]
----
Expand All @@ -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[]
----
Expand All @@ -228,7 +228,6 @@ Example:

video::video-file.mp4[]

FIXME: Add sample image, audio and video files.

== TABLES

Expand Down
26 changes: 12 additions & 14 deletions modules/references/pages/glossary.adoc
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
Loading