Skip to content

[DO NOT MERGE] General edits and FIXMEs #5

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 11 commits into from
Jan 27, 2025
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
4 changes: 2 additions & 2 deletions antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Red Hat Open Training Developer Guide
version: 1
nav:
- modules/ROOT/nav.adoc
- modules/starthere/nav.adoc
- modules/quickcourse/nav.adoc
- modules/start_here/nav.adoc
- modules/course_guide/nav.adoc
- modules/lab/nav.adoc
- modules/references/nav.adoc
13 changes: 10 additions & 3 deletions modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,15 @@

== Introduction

This comprehensive guide serves as a reference for anyone looking to contribute to the training content development via Red Hat Open Training creation program.
This comprehensive guide serves as a reference for anyone interested in developing or contributing training content via the Red Hat Open Training program.

The Open Training Creation program empowers subject matter experts within the organization to share their knowledge and expertise across the company and beyond.
The Open Training program empowers subject matter experts within the organization to share their knowledge and expertise across the company and beyond.
Read more about the program https://spaces.redhat.com/pages/viewpage.action?pageId=512755273[here,window=_blank].

This offering aims to reduce the time required to build training content while addressing challenges such as covering a wide range of technologies, adapting to fast-changing product life cycles, and meeting the diverse needs of different audiences.
A key goal of this program is to enable "citizen developers" and reduce the time required to build and maintain training content.
Creating training content for such a wide variety of products and technologies with fast product lifecycles to meet the needs of different audiences is impossible to do alone.
It takes more than a single team to do this and Red Hat is the perfect place to solicit content and participation from a large group of highly skilled people that care about each other's success.

If you are here, you are already interested.
Move on to the xref:start_here:workflow.adoc[Getting Started] section if you are new to this.
Otherwise, use the menu on the left to find a section you need.
File renamed without changes.
4 changes: 4 additions & 0 deletions modules/course_guide/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
* xref:index.adoc[]
** xref:course_structure.adoc[]
** xref:dev_spaces.adoc[]
** xref:local_system.adoc[]
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
= Quick course content format guide
= Course Structure

image::../qc-structure.jpg[]

The structure of the course is organized as a hierarchy, so it's helpful to think of the content in terms of chapters, or modules, and then pages, or sections.

At the top level (course), the antora.yml file defines the overall structure. It has the course title and the links to `nav.adoc` files in each module (aka chapter - they are the same thing here).
At the top level (course), the antora.yml file defines the overall structure. It has the course title and the links to `nav.adoc` files in each module (aka chapter - they are the same thing here).

[source]
----
Expand Down
Original file line number Diff line number Diff line change
@@ -1,37 +1,43 @@
= Use Devspace (skip if using local system)
:toc:

== Get started
Every Open Training course is developed in public GitHub repositories.
In order to make development as easy as possible, we provide you with the option of using a Dev Spaces instance.
If you're not familiar with this, just think of it as your normal IDE (VSCode in this case) running in the cloud.
It has everything you should need to write asciidoc, render into a preview, and interact with GitHub to push and pull.

Follow the instructions on xref:starthere:workflow.adoc[Get Started] page and wait for a response from the training team.
:toc:

== Draft content
== Set up or Access Dev Spaces Instance

. Once you receive your GitHub content repository, go to your GitHub project page and, in the README section, click the `Developer Workspace` button.
. After the GitHub repository is created for the course, you will see a `Developer Workspace` button in the README section of the repository.
+
Click this button to launch the Dev Spaces instance.
+
image::../click-devspace-button.png[]

. When prompted, select the `Log in with OpenShift` button and use the credentials that you were provided.
+
. On the next page, click the `Log in with OpenShift` button.
This is usually your Red Hat SSO credential.
+
image::../click-login-with-openshift.png[]
+
. Use the credentials provided by the training team to log in.
+
image::../ocp-devspace-login.png[]
+
. Click on the option to `Open the existing workspace` or `Switch to running workspace` if prompted.

. Once you have successfully logged in, select the option to `Open the existing workspace` or `Switch to running workspace` if prompted.
+
Ignore this step if not prompted for this option.
+
image::../select-workspace-1.png[]
+
or
+
image::../select-workspace-2.png[]
+

. When the VSCode interface loads, click `Yes, I trust the authors`.
+
image::../trust-authors.png[]
+
NOTE: Why do I trust them?

That is it!
You are ready to start writing your content.
The file and folder structure is already in place, so you just need to start filling in blanks and deleting files that you won't need.

== Render content draft

Expand Down
16 changes: 16 additions & 0 deletions modules/course_guide/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
= Course Contributor Guide

This section contains instructions on how to write your content.

First, you can find the overall course structure guide xref:course_structure.adoc[here].
If you are familiar with Antora, you have a small head start.
If you are new to this, don't worry - you only need to know a few things before you start working on your content.

After this, you can choose your approach to developing the content.
We have provided two options for you:

. Use a xref:dev_spaces.adoc[Dev Spaces] instance configured to work with the course repository.
If you're not used to using an IDE and are not as familiar with git, this is a good option for you.

. Use your xref:local_system.adoc[local system].
If you want to use your own customized IDE and you know how to use git, this option is for you.
4 changes: 0 additions & 4 deletions modules/quickcourse/nav.adoc

This file was deleted.

4 changes: 0 additions & 4 deletions modules/quickcourse/pages/index.adoc

This file was deleted.

8 changes: 4 additions & 4 deletions modules/references/pages/asciidocqrg.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -66,20 +66,20 @@ Link to an *external website* with the https://docs.asciidoctor.org/asciidoc/lat
Link to an external website with https://docs.asciidoctor.org/asciidoc/latest/[click here,window=_blank].
----

Link to a different *page in the same section* with xref:text.adoc[the other page within the same section]. (This will open in the same browser window.)
Link to a different *page in the same section* with xref:faq.adoc[the other page within the same section]. (This will open in the same browser window.)

.Syntax:
[source]
----
Link to another page in the same section with xref:text.adoc[the other page within the same section].
Link to another page in the same section with xref:faq.adoc[the other page within the same section].
----

Link to a *page in a different section* with xref:demolab:section1.adoc[the other page in the different section]. (This will open in the same browser window.)
Link to a *page in a different section* with xref:course_guide:course_structure.adoc[the other page in the different section]. (This will open in the same browser window.)

.Syntax:
[source]
----
Link to a page in a different section with xref:demolab:section1.adoc[the other page in the different section].
Link to a page in a different section with xref:course_guide:course_structure.adoc[the other page in the different section].
----

== LISTS AND BULLETS
Expand Down
File renamed without changes.
30 changes: 30 additions & 0 deletions modules/start_here/pages/workflow.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
= Getting started

You don't need to overplan, but you should have a plan.
Follow these high level steps to get started:

. Make sure you know what kind of training you want to create.
There are a few different types to choose from:
* xref:references:glossary.adoc#Know-It[know-it training] focuses on knowledge content and does not have any lab environments.
Think about this as something closer to a blog.
* xref:references:glossary.adoc#How-To[how-to training] focuses on hands-on labs across a variety of activities from installation to use-cases with Red Hat products.
* xref:references:glossary.adoc#Break-Fix[break-fix training] is a subset of how-to and focuses on on troubleshooting activities in a hands-on lab environment.

. If you need a learner to have a lab environment, decide which one you want to use:
* xref:references:glossary.adoc#RHDP[Red Hat Demo Platform (RHDP)] is the preferred lab type and should be suitable for all *how-to* and *break-fix* content.
* xref:references:glossary.adoc#ROLE[ROLE] can be used for content that has an established plan for publication on the GLS platform.

. Submit a https://docs.google.com/forms/d/e/1FAIpQLSepUaRiRdyA3PEzLP8w59reAsKRe19dL3ewpJGvJ7Gbggt-xg/viewform[training request,window=_blank] for type *Open Training*.
This will notify our Learning Product Managers and they will contact you as quickly as possible either with a request for more information or with the next steps, which is usually to connect you with the team that will help get your work going.
+
NOTE: You may track or update your request in https://issues.redhat.com/secure/RapidBoard.jspa?rapidView=20243[Jira,window=_blank].

. Once the request is validated and approved, write the content and work with the PTL team to develop the lab environment.
This is the part that you came here to do and where you should spend most of your time.

== What Next?

Once you have completed these steps and are ready to start, you can find more guidance in the following sections:

* xref:course_guide:index.adoc[Course development]
* xref:lab:index.adoc[Lab development]
16 changes: 0 additions & 16 deletions modules/starthere/pages/workflow.adoc

This file was deleted.

Loading