From 2418d36f413256112fd42e809b679ead3fc9ff6e Mon Sep 17 00:00:00 2001 From: Ted Singdahlsen Date: Tue, 1 Oct 2024 09:59:12 -0400 Subject: [PATCH 1/7] Update asciidocqrg.adoc --- modules/references/pages/asciidocqrg.adoc | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/modules/references/pages/asciidocqrg.adoc b/modules/references/pages/asciidocqrg.adoc index dea30d9..80aebd3 100644 --- a/modules/references/pages/asciidocqrg.adoc +++ b/modules/references/pages/asciidocqrg.adoc @@ -79,11 +79,9 @@ Example use of hyperlink to xref:demolab:section1.adoc[the other page in the dif .Syntax: [source] ---- -Example use of hyperlink to xref:text.adoc[the other page within the same section] of the course. This link opens in the same browser window. +Example use of hyperlink to xref:text.adoc[another page within the same section] of the course. This link opens in the same browser window. ---- -FIXME: steps for link within the same page. - == LISTS AND BULLETS . Numbered Step 1 @@ -258,5 +256,3 @@ Table with header row: |Cell in column 1, row 3 |Cell in column 2, row 3 |=== - -FIXME: Use of tables needs better explanation and example. From 5e52cd8298bae306d5cedcbe3c801ac0478e10bc Mon Sep 17 00:00:00 2001 From: Ted Singdahlsen Date: Tue, 1 Oct 2024 10:02:19 -0400 Subject: [PATCH 2/7] Update asciidocqrg.adoc --- modules/references/pages/asciidocqrg.adoc | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/modules/references/pages/asciidocqrg.adoc b/modules/references/pages/asciidocqrg.adoc index 64e5148..54a96c3 100644 --- a/modules/references/pages/asciidocqrg.adoc +++ b/modules/references/pages/asciidocqrg.adoc @@ -79,11 +79,7 @@ Link to a *page in a different section* with xref:demolab:section1.adoc[the othe .Syntax: [source] ---- -<<<<<<< HEAD -Example use of hyperlink to xref:text.adoc[another page within the same section] of the course. This link opens in the same browser window. -======= Link to a page in a different section with xref:demolab:section1.adoc[the other page in the different section]. ->>>>>>> 777255d794a07611a2f0e1df907e241769195100 ---- == LISTS AND BULLETS @@ -127,10 +123,10 @@ Link to a page in a different section with xref:demolab:section1.adoc[the other FIXME: The syntax for the `source` option is not rendered correctly in the code block. -[source] ----- -Code block with copy button. ----- +'[source]' +'----' +'Code block with copy button.' +'----' .Syntax: [source] From 0d154a8bbf07d7e213af7de9081b53834cd4270f Mon Sep 17 00:00:00 2001 From: Ted Singdahlsen Date: Tue, 1 Oct 2024 10:07:51 -0400 Subject: [PATCH 3/7] Update asciidocqrg.adoc --- modules/references/pages/asciidocqrg.adoc | 34 +---------------------- 1 file changed, 1 insertion(+), 33 deletions(-) diff --git a/modules/references/pages/asciidocqrg.adoc b/modules/references/pages/asciidocqrg.adoc index 54a96c3..0c58ec8 100644 --- a/modules/references/pages/asciidocqrg.adoc +++ b/modules/references/pages/asciidocqrg.adoc @@ -120,39 +120,7 @@ Link to a page in a different section with xref:demolab:section1.adoc[the other == CODE BLOCKS - -FIXME: The syntax for the `source` option is not rendered correctly in the code block. - -'[source]' -'----' -'Code block with copy button.' -'----' - -.Syntax: -[source] ----- -FIXME -[source] ----- -Code block for command with copy button. ----- ----- - -.Sample Output ----- -Code block to show sample output of the command. -This does not have copy button. ----- - -[source] ----- -FIXME -.Sample Output ----- -Code block to show sample output of the command. -This does not have copy button. ----- ----- +Refer to https://docs.asciidoctor.org/asciidoc/latest/verbatim/source-blocks/[Asciidoc documentation,window=_blank]. == CALLOUTS From 40448fc1b92e73a6e48e50d32c4c3e4b3722d41d Mon Sep 17 00:00:00 2001 From: Ted Singdahlsen Date: Tue, 1 Oct 2024 10:14:56 -0400 Subject: [PATCH 4/7] Rename red-hat-logo.jpeg to sample-image.jpg --- .../images/{red-hat-logo.jpeg => sample-image.jpg} | Bin 1 file changed, 0 insertions(+), 0 deletions(-) rename modules/references/images/{red-hat-logo.jpeg => sample-image.jpg} (100%) diff --git a/modules/references/images/red-hat-logo.jpeg b/modules/references/images/sample-image.jpg similarity index 100% rename from modules/references/images/red-hat-logo.jpeg rename to modules/references/images/sample-image.jpg From f1e9c16e5c550ffccb66ceb86ad6f3dc11fe2bb8 Mon Sep 17 00:00:00 2001 From: Ted Singdahlsen Date: Tue, 1 Oct 2024 10:15:23 -0400 Subject: [PATCH 5/7] Update asciidocqrg.adoc --- modules/references/pages/asciidocqrg.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/references/pages/asciidocqrg.adoc b/modules/references/pages/asciidocqrg.adoc index 0c58ec8..7709030 100644 --- a/modules/references/pages/asciidocqrg.adoc +++ b/modules/references/pages/asciidocqrg.adoc @@ -169,7 +169,7 @@ CAUTION: Highlighted text for Caution Callout 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[] +image::sample-image.jpg[] ---- Example: From 4b684b579565bc8bd8dd0bf52cb54abe00895cbb Mon Sep 17 00:00:00 2001 From: Ted Singdahlsen Date: Tue, 1 Oct 2024 15:30:32 -0400 Subject: [PATCH 6/7] asciidoc update Quick course content format guide content added --- modules/.DS_Store | Bin 6148 -> 6148 bytes modules/quickcourse/.DS_Store | Bin 6148 -> 6148 bytes modules/quickcourse/pages/section3.adoc | 30 +++++++++++++++++++++++- 3 files changed, 29 insertions(+), 1 deletion(-) diff --git a/modules/.DS_Store b/modules/.DS_Store index c23cebf4e05a33ba81bc2f4e7bd56429991bf7a6..ccd5c86411eb3e07b2c1f05c2c28bf4dd892f7af 100644 GIT binary patch delta 46 zcmZoMXffCj#>%*TayV-tmw0uxxv8m+f|1eWbu7}1os-|Q$}@It=4boCxS5UPA3p$8 Ck`A5# delta 39 vcmZoMXffCj#>%*3ayV-tw?uWdxtWEIg0Z35 Date: Wed, 2 Oct 2024 09:13:58 -0400 Subject: [PATCH 7/7] resolved a bunch of FIXMEs still some gaps --- modules/ROOT/pages/index.adoc | 7 +--- modules/appendix-DEL/nav.adoc | 1 - modules/asciidoc-DEL/nav.adoc | 9 ---- modules/asciidoc-DEL/pages/callouts.adoc | 41 ------------------- modules/asciidoc-DEL/pages/code.adoc | 34 --------------- modules/asciidoc-DEL/pages/headings.adoc | 25 ----------- modules/asciidoc-DEL/pages/index.adoc | 4 -- modules/asciidoc-DEL/pages/links.adoc | 27 ------------ modules/asciidoc-DEL/pages/lists.adoc | 36 ---------------- modules/asciidoc-DEL/pages/media.adoc | 30 -------------- modules/asciidoc-DEL/pages/tables.adoc | 31 -------------- modules/asciidoc-DEL/pages/text.adoc | 29 ------------- modules/demolab-DEL/nav.adoc | 3 -- modules/demolab-DEL/pages/index.adoc | 7 ---- modules/demolab-DEL/pages/section1.adoc | 6 --- modules/demolab-DEL/pages/section2.adoc | 6 --- modules/devspace-DEL/nav.adoc | 2 - modules/devspace-DEL/pages/index.adoc | 7 ---- modules/devspace-DEL/pages/section1.adoc | 3 -- modules/local-DEL/nav.adoc | 2 - modules/local-DEL/pages/index.adoc | 7 ---- modules/local-DEL/pages/section1.adoc | 3 -- modules/opentraining-DEL/nav.adoc | 7 ---- modules/opentraining-DEL/pages/index.adoc | 5 --- modules/opentraining-DEL/pages/section1.adoc | 12 ------ modules/opentraining-DEL/pages/section2.adoc | 9 ---- modules/opentraining-DEL/pages/section3.adoc | 3 -- modules/opentraining-DEL/pages/section4.adoc | 7 ---- modules/opentraining-DEL/pages/section5.adoc | 3 -- modules/opentraining-DEL/pages/section6.adoc | 6 --- modules/quickcourse/.DS_Store | Bin 6148 -> 6148 bytes modules/quickcourse/pages/section1.adoc | 4 +- modules/references/pages/faq.adoc | 2 - modules/references/pages/index.adoc | 2 +- modules/rolelab-DEL/nav.adoc | 3 -- modules/rolelab-DEL/pages/index.adoc | 7 ---- modules/rolelab-DEL/pages/section1.adoc | 6 --- modules/rolelab-DEL/pages/section2.adoc | 6 --- 38 files changed, 4 insertions(+), 398 deletions(-) delete mode 100644 modules/appendix-DEL/nav.adoc delete mode 100644 modules/asciidoc-DEL/nav.adoc delete mode 100644 modules/asciidoc-DEL/pages/callouts.adoc delete mode 100644 modules/asciidoc-DEL/pages/code.adoc delete mode 100644 modules/asciidoc-DEL/pages/headings.adoc delete mode 100644 modules/asciidoc-DEL/pages/index.adoc delete mode 100644 modules/asciidoc-DEL/pages/links.adoc delete mode 100644 modules/asciidoc-DEL/pages/lists.adoc delete mode 100644 modules/asciidoc-DEL/pages/media.adoc delete mode 100644 modules/asciidoc-DEL/pages/tables.adoc delete mode 100644 modules/asciidoc-DEL/pages/text.adoc delete mode 100644 modules/demolab-DEL/nav.adoc delete mode 100644 modules/demolab-DEL/pages/index.adoc delete mode 100644 modules/demolab-DEL/pages/section1.adoc delete mode 100644 modules/demolab-DEL/pages/section2.adoc delete mode 100644 modules/devspace-DEL/nav.adoc delete mode 100644 modules/devspace-DEL/pages/index.adoc delete mode 100644 modules/devspace-DEL/pages/section1.adoc delete mode 100644 modules/local-DEL/nav.adoc delete mode 100644 modules/local-DEL/pages/index.adoc delete mode 100644 modules/local-DEL/pages/section1.adoc delete mode 100644 modules/opentraining-DEL/nav.adoc delete mode 100644 modules/opentraining-DEL/pages/index.adoc delete mode 100644 modules/opentraining-DEL/pages/section1.adoc delete mode 100644 modules/opentraining-DEL/pages/section2.adoc delete mode 100644 modules/opentraining-DEL/pages/section3.adoc delete mode 100644 modules/opentraining-DEL/pages/section4.adoc delete mode 100644 modules/opentraining-DEL/pages/section5.adoc delete mode 100644 modules/opentraining-DEL/pages/section6.adoc delete mode 100644 modules/rolelab-DEL/nav.adoc delete mode 100644 modules/rolelab-DEL/pages/index.adoc delete mode 100644 modules/rolelab-DEL/pages/section1.adoc delete mode 100644 modules/rolelab-DEL/pages/section2.adoc diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index f162270..ec2db36 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -1,4 +1,4 @@ -= Red Hat Open Training Developer Guide += Red Hat Open Training Contributor Guide :navtitle: Home == Introduction @@ -7,7 +7,4 @@ This comprehensive guide serves as a reference for anyone looking to contribute The Open Training Creation program empowers subject matter experts within the organization to share their knowledge and expertise across the company and beyond. -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. - - -FIXME: change the title to contributor guide \ No newline at end of file +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. \ No newline at end of file diff --git a/modules/appendix-DEL/nav.adoc b/modules/appendix-DEL/nav.adoc deleted file mode 100644 index 92a20a7..0000000 --- a/modules/appendix-DEL/nav.adoc +++ /dev/null @@ -1 +0,0 @@ -* xref:appendix.adoc[] \ No newline at end of file diff --git a/modules/asciidoc-DEL/nav.adoc b/modules/asciidoc-DEL/nav.adoc deleted file mode 100644 index 76f1aa4..0000000 --- a/modules/asciidoc-DEL/nav.adoc +++ /dev/null @@ -1,9 +0,0 @@ -* xref:index.adoc[] -** xref:headings.adoc[] -** xref:text.adoc[] -** xref:links.adoc[] -** xref:lists.adoc[] -** xref:code.adoc[] -** xref:callouts.adoc[] -** xref:media.adoc[] -** xref:tables.adoc[] \ No newline at end of file diff --git a/modules/asciidoc-DEL/pages/callouts.adoc b/modules/asciidoc-DEL/pages/callouts.adoc deleted file mode 100644 index cf06d36..0000000 --- a/modules/asciidoc-DEL/pages/callouts.adoc +++ /dev/null @@ -1,41 +0,0 @@ -= Callouts - -NOTE: Highlighted text for Note Callout - -.Syntax: -[source] ----- -NOTE: Highlighted text for Note Callout ----- - -WARNING: Highlighted text for Warning Callout - -.Syntax: -[source] ----- -WARNING: Highlighted text for Warning Callout ----- - -IMPORTANT: Highlighted text for Important Callout - -.Syntax: -[source] ----- -IMPORTANT: Highlighted text for Important Callout ----- - -TIP: Highlighted text for Tip Callout - -.Syntax: -[source] ----- -TIP: Highlighted text for Tip Callout ----- - -CAUTION: Highlighted text for Caution Callout - -.Syntax: -[source] ----- -CAUTION: Highlighted text for Caution Callout ----- \ No newline at end of file diff --git a/modules/asciidoc-DEL/pages/code.adoc b/modules/asciidoc-DEL/pages/code.adoc deleted file mode 100644 index d012fca..0000000 --- a/modules/asciidoc-DEL/pages/code.adoc +++ /dev/null @@ -1,34 +0,0 @@ -= Code blocks - -FIXME: The syntax for the `source` option is not rendered correctly in the code block. - -[source] ----- -Code block for command with copy button. ----- - -.Syntax: -[source] ----- -FIXME -[source] ----- -Code block for command with copy button. ----- ----- - -.Sample Output ----- -Code block to show sample output of the command. -This does not have copy button. ----- - -[source] ----- -FIXME -.Sample Output ----- -Code block to show sample output of the command. -This does not have copy button. ----- ----- \ No newline at end of file diff --git a/modules/asciidoc-DEL/pages/headings.adoc b/modules/asciidoc-DEL/pages/headings.adoc deleted file mode 100644 index 31f6257..0000000 --- a/modules/asciidoc-DEL/pages/headings.adoc +++ /dev/null @@ -1,25 +0,0 @@ -= Headings - -Above is example of *top level heading*. This is referenced for navigation (previous/next) of the pages in rendered training content. - -.Syntax: -[source] ----- -= This is top level heading ----- - -== This is Second level heading - -.Syntax: -[source] ----- -== This is Second level heading ----- - -=== This is Third level heading - -.Syntax: -[source] ----- -=== This is Third level heading ----- diff --git a/modules/asciidoc-DEL/pages/index.adoc b/modules/asciidoc-DEL/pages/index.adoc deleted file mode 100644 index d461ad5..0000000 --- a/modules/asciidoc-DEL/pages/index.adoc +++ /dev/null @@ -1,4 +0,0 @@ -= (DELETE THIS) Asciidoc quick reference guide - -This section serves as a quick reference for commonly used AsciiDoc syntax, helpful for developing content with Red Hat QuickCourse. Use it as a convenient guide to copy and apply AsciiDoc formatting in your content. - diff --git a/modules/asciidoc-DEL/pages/links.adoc b/modules/asciidoc-DEL/pages/links.adoc deleted file mode 100644 index cfb9b88..0000000 --- a/modules/asciidoc-DEL/pages/links.adoc +++ /dev/null @@ -1,27 +0,0 @@ -= Link - -* Example use of hyperlink to external website with https://docs.asciidoctor.org/asciidoc/latest/[click here,window=_blank] option. The link opens in another tab or window of the browser. - -.Syntax: -[source] ----- -Example use of hyperlink to external website with https://docs.asciidoctor.org/asciidoc/latest/[click here,window=_blank] option. ----- - -* Example use of hyperlink to xref:demolab:section1.adoc[the other page in the different section] within the same course. This link opens in the same browser window. - -.Syntax: -[source] ----- -Example use of hyperlink to xref:demolab:section1.adoc[the other page in the different section] within the same course. This link opens in the same browser window. ----- - -* Example use of hyperlink to xref:text.adoc[the other page within the same section] of the course. This link opens in the same browser window. - -.Syntax: -[source] ----- -Example use of hyperlink to xref:text.adoc[the other page within the same section] of the course. This link opens in the same browser window. ----- - -FIXME: steps for link within the same page. \ No newline at end of file diff --git a/modules/asciidoc-DEL/pages/lists.adoc b/modules/asciidoc-DEL/pages/lists.adoc deleted file mode 100644 index 6bc577c..0000000 --- a/modules/asciidoc-DEL/pages/lists.adoc +++ /dev/null @@ -1,36 +0,0 @@ -= Lists and Bullets - -. Numbered Step 1 -. Numbered Step 2 -. Numbered Step 3 - .. Sub Numbered Step 1 - .. Sub Numbered Step 2 -. Numbered Step 4 - -.Syntax: -[source] ----- -. Numbered Step 1 -. Numbered Step 2 -. Numbered Step 3 - .. Sub Numbered Step 1 - .. Sub Numbered Step 2 -. Numbered Step 4 ----- - -* Bullet list item 1 -* Bullet list item 2 - ** Sub Bullet list item 1 - ** Sub Bullet list item 2 -* Bullet list item 3 - -.Syntax: -[source] ----- -* Bullet list item 1 -* Bullet list item 2 - ** Sub Bullet list item 1 - ** Sub Bullet list item 2 -* Bullet list item 3 ----- - diff --git a/modules/asciidoc-DEL/pages/media.adoc b/modules/asciidoc-DEL/pages/media.adoc deleted file mode 100644 index 99e87ce..0000000 --- a/modules/asciidoc-DEL/pages/media.adoc +++ /dev/null @@ -1,30 +0,0 @@ -= Media - -To render an image on the page, copy required image in `modules/chapterN/images` directory and reference it as below ----- -image::sample-image.png[] ----- - -Example: - -image::sample-image.png[] - -Use below syntax to use audio file on your content ----- -audio::audio-file.wav[] ----- - -Example: - -audio::audio-file.wav[] - -Use below syntax to render a video file on your content page. ----- -video::video-file.mp4[] ----- - -Example: - -video::video-file.mp4[] - -FIXME: Add sample image, audio and video files. \ No newline at end of file diff --git a/modules/asciidoc-DEL/pages/tables.adoc b/modules/asciidoc-DEL/pages/tables.adoc deleted file mode 100644 index 9b00038..0000000 --- a/modules/asciidoc-DEL/pages/tables.adoc +++ /dev/null @@ -1,31 +0,0 @@ -= Tables - -Table without header row: - -[cols="1,1"] -|=== -|Cell in column 1, row 1 -|Cell in column 2, row 1 - -|Cell in column 1, row 2 -|Cell in column 2, row 2 - -|Cell in column 1, row 3 -|Cell in column 2, row 3 -|=== - -Table with header row: - -[cols="2*",options="header"] -|=== -|Column 1, header row -|Column 2, header row - -|Cell in column 1, row 2 -|Cell in column 2, row 2 - -|Cell in column 1, row 3 -|Cell in column 2, row 3 -|=== - -FIXME: Use of tables needs better explanation and example. \ No newline at end of file diff --git a/modules/asciidoc-DEL/pages/text.adoc b/modules/asciidoc-DEL/pages/text.adoc deleted file mode 100644 index e6d957c..0000000 --- a/modules/asciidoc-DEL/pages/text.adoc +++ /dev/null @@ -1,29 +0,0 @@ -= Text - -This is example of normal text. -You may write the text with *Bold* or _Italic_, font. -You may also use `commands in back ticks` as per requirement. -You may #highlight# the #required portion# of any text. - -.Syntax: -[source] ----- -This is example of normal text. -You may write the text with *Bold* or _Italic_, font. -You may also use `commands in back ticks` as per requirement. -You may #highlight# the #required portion# of any text. ----- - -Add the text with gap of a line for new paragraph. - -You may also use hard line breaks like this + -for new line in single paragraph. - -.Syntax: -[source] ----- -Add the text with gap of a line for new paragraph. - -You may also use hard line breaks like this + -for new line in single paragraph. ----- diff --git a/modules/demolab-DEL/nav.adoc b/modules/demolab-DEL/nav.adoc deleted file mode 100644 index d6da93d..0000000 --- a/modules/demolab-DEL/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/demolab-DEL/pages/index.adoc b/modules/demolab-DEL/pages/index.adoc deleted file mode 100644 index de11ee3..0000000 --- a/modules/demolab-DEL/pages/index.adoc +++ /dev/null @@ -1,7 +0,0 @@ -= Hands-on Lab development guide (Demo platform) - -In this section, we cover... FIXME - - -- Add or remove section entries in the `antora.yaml` file as needed. -- Ensure you create or delete the corresponding directory for the chapter accordingly. diff --git a/modules/demolab-DEL/pages/section1.adoc b/modules/demolab-DEL/pages/section1.adoc deleted file mode 100644 index 149161f..0000000 --- a/modules/demolab-DEL/pages/section1.adoc +++ /dev/null @@ -1,6 +0,0 @@ -= Section 1 - -* Create multiple copies of this section as needed. -* Remove any unnecessary sections or chapter pages. -* Customize the section as appropriate. -* Ensure that each page contains a manageable amount of content. diff --git a/modules/demolab-DEL/pages/section2.adoc b/modules/demolab-DEL/pages/section2.adoc deleted file mode 100644 index 1a3ce63..0000000 --- a/modules/demolab-DEL/pages/section2.adoc +++ /dev/null @@ -1,6 +0,0 @@ -= Section 2 - -* Create multiple copies of this section as needed. -* Remove any unnecessary sections or chapter pages. -* Customize the section as appropriate. -* Ensure that each page contains a manageable amount of content. diff --git a/modules/devspace-DEL/nav.adoc b/modules/devspace-DEL/nav.adoc deleted file mode 100644 index 62b8058..0000000 --- a/modules/devspace-DEL/nav.adoc +++ /dev/null @@ -1,2 +0,0 @@ -* xref:index.adoc[] -** xref:section1.adoc[] \ No newline at end of file diff --git a/modules/devspace-DEL/pages/index.adoc b/modules/devspace-DEL/pages/index.adoc deleted file mode 100644 index 90e212b..0000000 --- a/modules/devspace-DEL/pages/index.adoc +++ /dev/null @@ -1,7 +0,0 @@ -= QuickCourse Contributor Guide (devspace) - -This section contains instructions on how to create and publish quick courses using the development environment offered by devspace. - -Use the instructions in this section if you plan to develop content using the development environment offered by our DevSpace implementation. - -NOTE: You can skip this section if you are using your local system for content development. diff --git a/modules/devspace-DEL/pages/section1.adoc b/modules/devspace-DEL/pages/section1.adoc deleted file mode 100644 index 9aa444e..0000000 --- a/modules/devspace-DEL/pages/section1.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Section 1 - -FIXME: Use the relevant content from https://redhatquickcourses.github.io/welcome/1/guide/overview.html[Contributor Guide,window=_blank] and https://github.com/RedHatQuickCourses/course-starter-template/blob/main/DEVSPACE.md[Development using devspace documentation,window=_blank] \ No newline at end of file diff --git a/modules/local-DEL/nav.adoc b/modules/local-DEL/nav.adoc deleted file mode 100644 index 62b8058..0000000 --- a/modules/local-DEL/nav.adoc +++ /dev/null @@ -1,2 +0,0 @@ -* xref:index.adoc[] -** xref:section1.adoc[] \ No newline at end of file diff --git a/modules/local-DEL/pages/index.adoc b/modules/local-DEL/pages/index.adoc deleted file mode 100644 index 90e212b..0000000 --- a/modules/local-DEL/pages/index.adoc +++ /dev/null @@ -1,7 +0,0 @@ -= QuickCourse Contributor Guide (devspace) - -This section contains instructions on how to create and publish quick courses using the development environment offered by devspace. - -Use the instructions in this section if you plan to develop content using the development environment offered by our DevSpace implementation. - -NOTE: You can skip this section if you are using your local system for content development. diff --git a/modules/local-DEL/pages/section1.adoc b/modules/local-DEL/pages/section1.adoc deleted file mode 100644 index 9aa444e..0000000 --- a/modules/local-DEL/pages/section1.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Section 1 - -FIXME: Use the relevant content from https://redhatquickcourses.github.io/welcome/1/guide/overview.html[Contributor Guide,window=_blank] and https://github.com/RedHatQuickCourses/course-starter-template/blob/main/DEVSPACE.md[Development using devspace documentation,window=_blank] \ No newline at end of file diff --git a/modules/opentraining-DEL/nav.adoc b/modules/opentraining-DEL/nav.adoc deleted file mode 100644 index 4af161e..0000000 --- a/modules/opentraining-DEL/nav.adoc +++ /dev/null @@ -1,7 +0,0 @@ -* xref:index.adoc[] -** xref:section1.adoc[] -** xref:section2.adoc[] -** xref:section3.adoc[] -** xref:section4.adoc[] -** xref:section5.adoc[] -** xref:section6.adoc[] \ No newline at end of file diff --git a/modules/opentraining-DEL/pages/index.adoc b/modules/opentraining-DEL/pages/index.adoc deleted file mode 100644 index 0f3def2..0000000 --- a/modules/opentraining-DEL/pages/index.adoc +++ /dev/null @@ -1,5 +0,0 @@ -= Start here - -The Open Training Creation program empowers subject matter experts within the organization to share their knowledge and expertise across the company and beyond. - -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. diff --git a/modules/opentraining-DEL/pages/section1.adoc b/modules/opentraining-DEL/pages/section1.adoc deleted file mode 100644 index d378e3f..0000000 --- a/modules/opentraining-DEL/pages/section1.adoc +++ /dev/null @@ -1,12 +0,0 @@ -= Workflow - -FIXME: Workflow flowchart - -* #Identify training requirement# -* #Identify lab template (if applicable)# -* `Create content repo and clone for lab` -* #Develop training and lab (if applicable)# -* `Quality check and Publish` - -NOTE: In the workflow above, #tasks in highlighted text# are to be performed outside the training team, while `tasks in normal text` are to be handled by the training team. - diff --git a/modules/opentraining-DEL/pages/section2.adoc b/modules/opentraining-DEL/pages/section2.adoc deleted file mode 100644 index de229f7..0000000 --- a/modules/opentraining-DEL/pages/section2.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= Identify training requirement - -The training you wish to contribute could originate from several sources: - -* You may identify a knowledge gap based on your own experience. -* You might notice a gap within your team that you want to address through training. -* You may receive a request from another team, partner, or customer for specific training. -* You could find a training topic in our backlog (FIXME link) that interests you and would like to contribute to. - diff --git a/modules/opentraining-DEL/pages/section3.adoc b/modules/opentraining-DEL/pages/section3.adoc deleted file mode 100644 index 8e96343..0000000 --- a/modules/opentraining-DEL/pages/section3.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Identify lab template - -FIXME: Instructions for identifying suitable lab template on Demo or ROLE platform diff --git a/modules/opentraining-DEL/pages/section4.adoc b/modules/opentraining-DEL/pages/section4.adoc deleted file mode 100644 index d65bb58..0000000 --- a/modules/opentraining-DEL/pages/section4.adoc +++ /dev/null @@ -1,7 +0,0 @@ -= Create content repo and Lab environment - -NOTE: The steps on this page are to be followed by the training team member assisting you with your Open Training contribution. - -FIXME: Pull content from https://github.com/RedHatQuickCourses/course-starter-template/blob/main/README.md - -FIXME: Steps for Lab environment to be done. \ No newline at end of file diff --git a/modules/opentraining-DEL/pages/section5.adoc b/modules/opentraining-DEL/pages/section5.adoc deleted file mode 100644 index 3c6d982..0000000 --- a/modules/opentraining-DEL/pages/section5.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Develop Training - -FIXME: Pull content from https://github.com/RedHatQuickCourses/course-starter-template/blob/main/README.md diff --git a/modules/opentraining-DEL/pages/section6.adoc b/modules/opentraining-DEL/pages/section6.adoc deleted file mode 100644 index 52e5aaf..0000000 --- a/modules/opentraining-DEL/pages/section6.adoc +++ /dev/null @@ -1,6 +0,0 @@ -= Quality check and Publish - -NOTE: The steps on this page are to be followed by the training team member assisting you with your Open Training contribution. - -FIXME: (TBD) Steps for submitting content for quality check and publishing with expected ETA. - diff --git a/modules/quickcourse/.DS_Store b/modules/quickcourse/.DS_Store index cf5a6a205af2cac910009675d958c9343ee3fb5b..d022e6fd27e64bbc5a9d9008d4bfc0b66d657fd9 100644 GIT binary patch delta 26 icmZoMXffFEgNc!0@=vB+n-4O(u}o~>+sw}KmmdI)ZVCzj delta 28 kcmZoMXffFEgNc!G@=vB+jEtKPGP|)%Y~bC@&heKY0GLq<3;+NC diff --git a/modules/quickcourse/pages/section1.adoc b/modules/quickcourse/pages/section1.adoc index b5cb0f4..5589cda 100644 --- a/modules/quickcourse/pages/section1.adoc +++ b/modules/quickcourse/pages/section1.adoc @@ -59,9 +59,7 @@ image::../devspace-pop-up.png[] . When you save your changes in the content files in devspace interface, the changes will be reflected in the rendered content url as soon as you refresh the url. - - -FIXME steps from https://github.com/RedHatQuickCourses/course-starter-template/blob/main/DEVSPACE.md +See https://github.com/RedHatQuickCourses/course-starter-template/blob/main/DEVSPACE.md == Commit changes to GitHub diff --git a/modules/references/pages/faq.adoc b/modules/references/pages/faq.adoc index 419f448..4eb2735 100644 --- a/modules/references/pages/faq.adoc +++ b/modules/references/pages/faq.adoc @@ -11,8 +11,6 @@ The training you wish to contribute could originate from several sources: * You may receive a request from another team, partner, or customer for specific training. -* Optionally, you could find a training topic in our backlog (FIXME link) that interests you and would like to contribute to. (FIXME: do we need this option?) - == When should I initiate the Open Training request? You should engage with us as soon as you have a training requirement. Don not wait until your content or hands-on labs are fully ready. We have tools and processes that can significantly reduce the time and effort needed to develop and publish your training materials. diff --git a/modules/references/pages/index.adoc b/modules/references/pages/index.adoc index 663e36f..eac9b1d 100644 --- a/modules/references/pages/index.adoc +++ b/modules/references/pages/index.adoc @@ -1,3 +1,3 @@ # References -FIXME This section contains . . . \ No newline at end of file +This section contains content that may be helpful as you develop your course. \ No newline at end of file diff --git a/modules/rolelab-DEL/nav.adoc b/modules/rolelab-DEL/nav.adoc deleted file mode 100644 index d6da93d..0000000 --- a/modules/rolelab-DEL/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/rolelab-DEL/pages/index.adoc b/modules/rolelab-DEL/pages/index.adoc deleted file mode 100644 index 8c19ea2..0000000 --- a/modules/rolelab-DEL/pages/index.adoc +++ /dev/null @@ -1,7 +0,0 @@ -= Hands-on Lab development guide (ROLE platform) - -In this section, we cover... FIXME - - -- Add or remove section entries in the `antora.yaml` file as needed. -- Ensure you create or delete the corresponding directory for the chapter accordingly. diff --git a/modules/rolelab-DEL/pages/section1.adoc b/modules/rolelab-DEL/pages/section1.adoc deleted file mode 100644 index 149161f..0000000 --- a/modules/rolelab-DEL/pages/section1.adoc +++ /dev/null @@ -1,6 +0,0 @@ -= Section 1 - -* Create multiple copies of this section as needed. -* Remove any unnecessary sections or chapter pages. -* Customize the section as appropriate. -* Ensure that each page contains a manageable amount of content. diff --git a/modules/rolelab-DEL/pages/section2.adoc b/modules/rolelab-DEL/pages/section2.adoc deleted file mode 100644 index 1a3ce63..0000000 --- a/modules/rolelab-DEL/pages/section2.adoc +++ /dev/null @@ -1,6 +0,0 @@ -= Section 2 - -* Create multiple copies of this section as needed. -* Remove any unnecessary sections or chapter pages. -* Customize the section as appropriate. -* Ensure that each page contains a manageable amount of content.