diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 31f850e..aa6c6a1 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -1 +1,2 @@ -* xref:index.adoc[] +* xref:index.adoc[Home] +* xref:ai-factory-accelerator.adoc[AI Factory accelerator] diff --git a/modules/ROOT/pages/ai-factory-accelerator.adoc b/modules/ROOT/pages/ai-factory-accelerator.adoc new file mode 100644 index 0000000..8193003 --- /dev/null +++ b/modules/ROOT/pages/ai-factory-accelerator.adoc @@ -0,0 +1,42 @@ += Red Hat & NVIDIA AI Factory Content Accelerator +:navtitle: AI Factory accelerator + +== The Mission: Industrialize Enterprise AI + +Welcome to the Virtual AI Factory w/ NVIDIA Content Accelerator. While we won't be in Frankfurt, this intensive, distributed hackathon is designed to bridge the gap between theoretical AI product knowledge and industrial-scale, real-world execution. + +In a world where AI can quickly generate code and match patterns, it still lacks the "hard knocks" of real-world trial and error. AI does not inherently understand *why* a specific architecture led to results, or why alternative methods technically work but ultimately fail in production. + +**That is where you come in.** Your true value lies in sharing the lessons learned through failure, iteration, and field experience. Together, we are going to translate your raw expertise into the "field-opinionated" playbooks and technical blueprints required to deliver Red Hat and NVIDIA AI Factory solutions at scale. + +== The Engine: Open Training & Giveback Incentives + +To rapidly capture and distribute your playbooks, we are utilizing the **Red Hat Open Training framework** as our delivery vehicle. You will build your blueprints using a straightforward "docs-as-code" approach (AsciiDoc and Antora), allowing you to focus purely on technical accuracy while the framework handles the formatting, scaling, and publishing. + +**Your Impact & Reward:** By contributing to this accelerator, you are directly empowering internal associates, partners, and customers to replicate your success. Furthermore, your published blueprints are highly visible and eligible for recognition through the **Red Hat Giveback Program** (e.g., earning 4 points for new courses and 3 points for updates). + +== Hackathon Goals & Business Impact + +To maintain focus and drive immediate customer value, your hackathon builds will target these core objectives. *(Note: Specific tracks and workloads will be finalized and assigned prior to our kickoff on the 15th).* + +* **Production-Ready Deployments:** Develop automated Quickstarts and Playbooks (using OpenShift AI and NVIDIA NIM) that provide the field with a clear, repeatable path to production, accelerating time-to-value. +* **Autonomous Agents:** Build enablement around the Llama Stack API and NVIDIA OpenShell runtime to guide teams in transitioning from simple chatbots to highly secure, industrial-scale AI agents. +* **High-Performance Serving:** Establish hardware and storage benchmarking standards for NVIDIA-Certified Systems to ensure deployments meet strict AI service level objectives and reduce TCO. +* **Security & Regulatory Compliance:** Integrate STIG-hardened containers, RHEL, and NVIDIA BlueField DPUs to deliver a zero-trust architecture for mission-critical, regulated industries. +* **AI-First Delivery & Enablement:** Apply an AI-first delivery approach using "skills" to automate framework delivery, shifting from traditional manual consulting to scalable, AI-assisted field operations for Specialists, Consultants, and Partners. + +== The Definition of "Done" + +By the end of this hackathon, a successful blueprint submission will include: +. A completed, AI-assisted **Course Design Document (CDD)** mapping out your technical concepts to actionable tasks. +. A working hands-on lab environment scenario (targeting the dual H100 baseline—either a step-by-step *How-To* or a troubleshooting *Break-Fix*). +. An Antora-compliant GitHub repository containing your structured AsciiDoc pages and navigation map. + +== Next Steps + +Ready to start building? Use the Open Training toolchain so you can focus on the technical story. + +* **Step 1:** Follow xref:start_here:ai-assisted-cdd.adoc[AI-Assisted Design Phase (CDD)] to generate a course outline from your notes. +* **Step 2:** Review formatting guidance under xref:references:asciidocqrg.adoc[References] and create your repo from the https://github.com/RedHatQuickCourses/course-starter-template[course-starter-template,window=_blank]. +* **Step 3:** Author your playbook in AsciiDoc and use the lab guidance under xref:lab:index.adoc[Lab Infrastructure]. +* **General Open Training path:** xref:start_here:workflow.adoc[Getting started] (non-hackathon contributors). \ No newline at end of file diff --git a/modules/ROOT/pages/index copy.adoc b/modules/ROOT/pages/index copy.adoc deleted file mode 100644 index 443c109..0000000 --- a/modules/ROOT/pages/index copy.adoc +++ /dev/null @@ -1,17 +0,0 @@ -= Red Hat Open Training Contributor Guide -:navtitle: Home - -== Introduction - -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 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]. - -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. \ No newline at end of file diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 6995bea..83843c1 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -1,41 +1,25 @@ -= Red Hat & NVIDIA AI Factory Content Accelerator -:navtitle: Event Summary += Red Hat Open Training Contributor Guide +:navtitle: Home -== The Mission: Industrialize Enterprise AI +== Introduction -Welcome to the Virtual AI Factory w/ NVIDIA Content Accelerator. While we won't be in Frankfurt, this intensive, distributed hackathon is designed to bridge the gap between theoretical AI product knowledge and industrial-scale, real-world execution. +This guide is the reference for anyone developing or contributing training content through the *Red Hat Open Training* program (Quick Courses built with AsciiDoc and Antora). -In a world where AI can quickly generate code and match patterns, it still lacks the "hard knocks" of real-world trial and error. AI does not inherently understand *why* a specific architecture led to results, or why alternative methods technically work but ultimately fail in production. +Open Training helps subject matter experts share knowledge across Red Hat and beyond. +Program overview and intake live on the PERT Confluence space: +https://redhat.atlassian.net/wiki/spaces/PERT/pages/291408641[Open Training Program,window=_blank]. -**That is where you come in.** Your true value lies in sharing the lessons learned through failure, iteration, and field experience. Together, we are going to translate your raw expertise into the "field-opinionated" playbooks and technical blueprints required to deliver Red Hat and NVIDIA AI Factory solutions at scale. +A key goal is to enable "citizen developers" and reduce the time required to build and maintain training content. +Creating content across many products and fast release cycles takes more than one team — this guide and the course starter template help you focus on the technical story while the framework handles structure and publishing. -== The Engine: Open Training & Giveback Incentives +== Start here -To rapidly capture and distribute your playbooks, we are utilizing the **Red Hat Open Training framework** as our delivery vehicle. You will build your blueprints using a straightforward "docs-as-code" approach (AsciiDoc and Antora), allowing you to focus purely on technical accuracy while the framework handles the formatting, scaling, and publishing. +. New to Open Training? Follow xref:start_here:workflow.adoc[Getting started]. +. Create a content repository from the https://github.com/RedHatQuickCourses/course-starter-template[course-starter-template,window=_blank] (see that repo README for `course-init.sh`). +. Need a lab environment? See the xref:lab:index.adoc[Lab Infrastructure Guide]. +. Formatting and AsciiDoc help: xref:references:asciidocqrg.adoc[AsciiDoc quick reference] and related pages under References. -**Your Impact & Reward:** By contributing to this accelerator, you are directly empowering internal associates, partners, and customers to replicate your success. Furthermore, your published blueprints are highly visible and eligible for recognition through the **Red Hat Giveback Program** (e.g., earning 4 points for new courses and 3 points for updates). +== Featured resource -== Hackathon Goals & Business Impact - -To maintain focus and drive immediate customer value, your hackathon builds will target these core objectives. *(Note: Specific tracks and workloads will be finalized and assigned prior to our kickoff on the 15th).* - -* **Production-Ready Deployments:** Develop automated Quickstarts and Playbooks (using OpenShift AI and NVIDIA NIM) that provide the field with a clear, repeatable path to production, accelerating time-to-value. -* **Autonomous Agents:** Build enablement around the Llama Stack API and NVIDIA OpenShell runtime to guide teams in transitioning from simple chatbots to highly secure, industrial-scale AI agents. -* **High-Performance Serving:** Establish hardware and storage benchmarking standards for NVIDIA-Certified Systems to ensure deployments meet strict AI service level objectives and reduce TCO. -* **Security & Regulatory Compliance:** Integrate STIG-hardened containers, RHEL, and NVIDIA BlueField DPUs to deliver a zero-trust architecture for mission-critical, regulated industries. -* **AI-First Delivery & Enablement:** Apply an AI-first delivery approach using "skills" to automate framework delivery, shifting from traditional manual consulting to scalable, AI-assisted field operations for Specialists, Consultants, and Partners. - -== The Definition of "Done" - -By the end of this hackathon, a successful blueprint submission will include: -. A completed, AI-assisted **Course Design Document (CDD)** mapping out your technical concepts to actionable tasks. -. A working hands-on lab environment scenario (targeting the dual H100 baseline—either a step-by-step *How-To* or a troubleshooting *Break-Fix*). -. An Antora-compliant GitHub repository containing your structured AsciiDoc pages and navigation map. - -== Next Steps - -Ready to start building? We have streamlined the toolchain so you can bypass the formatting hurdles and get straight to the code. - -* **Step 1:** Head over to the **AI-Assisted Design Phase** to put together and generate your course outline from your raw notes and references. -* **Step 2:** Review the **Formatting Cheat Sheet** to understand how to structure your repository and add formatting flavor to your content. -* **Step 3:** Start coding your playbook! \ No newline at end of file +Building for the Red Hat & NVIDIA AI Factory accelerator? +See xref:ai-factory-accelerator.adoc[AI Factory Content Accelerator] for hackathon goals, definition of done, and next steps (including the AI-assisted Course Design Document path under Getting Started). diff --git a/modules/start_here/nav.adoc b/modules/start_here/nav.adoc index 720261d..abd85a5 100644 --- a/modules/start_here/nav.adoc +++ b/modules/start_here/nav.adoc @@ -1 +1,3 @@ -* xref:workflow.adoc[] +* Getting started +** xref:workflow.adoc[Getting started] +** xref:ai-assisted-cdd.adoc[AI-assisted CDD (AI Factory)] diff --git a/modules/start_here/pages/ai-assisted-cdd.adoc b/modules/start_here/pages/ai-assisted-cdd.adoc new file mode 100644 index 0000000..c3968a3 --- /dev/null +++ b/modules/start_here/pages/ai-assisted-cdd.adoc @@ -0,0 +1,62 @@ += AI-Assisted Design Phase (The CDD) +:navtitle: Course Design Phase + +== Skip the Blank Page Syndrome + +As an elite engineer, your time during this hackathon is best spent on technical execution and architecture. + +However, before you start writing AsciiDoc, you need a blueprint. We call this the **Course Design Document (CDD)**. We have an automated script (`skill.md`) that will read this CDD and automatically generate your entire GitHub repository structure, folders, and navigation map for you. + +To ensure the automation works, we ask that your CDD be in the following specific Markdown format. + +== Step 1: The AI Generation Prompt + +The prompt below contains the specific template. You are paste it into your preferred AI assistant (e.g., ChatGPT, Claude, Red Hat Lightspeed) along with your raw technical notes. + +[source,text] +---- +You are an expert technical instructional designer. I am going to provide you with my raw notes, terminal outputs, and code snippets for a new Red Hat AI Factory with NVIDIA technical blueprint. + +Your task is to organize my notes into a structured Course Design Document (CDD) using STRICT Markdown formatting. The tone must be highly technical and geared toward Senior Platform Engineers and SREs. Heavily emphasize production-ready deployments, AI-first delivery methodology (using skills), and troubleshooting. + +CRITICAL: You must output the document exactly matching the schema below. Do not deviate from these heading names or the table structure, as this output will be parsed by an automated script. + +# [Insert Course Title Here] + +# COURSE GOAL +[Write a 2-3 sentence overarching goal for the blueprint] + +# TARGET AUDIENCE +[Define the primary persona, e.g., SRE, Platform Engineer] + +# PREREQUISITES +[List required prior knowledge and tools] + +# LAB INFRASTRUCTURE REQUIREMENTS +[Define hardware, required software, and pre-provisioned state. Note: Target baseline is NVIDIA Launchpad environments with dual H100 nodes unless otherwise specified.] + +# COURSE DESIGN +| Description | Session Type | +| --- | --- | +| LEARNING OBJECTIVE #1: [Insert objective here] | | +| [Insert specific hands-on task or troubleshooting concept] | Lecture | +| [Insert the specific Lab scenario and Validation Checkpoints] | Lab | +| LEARNING OBJECTIVE #2: [Insert objective here] | | +| [Insert specific hands-on task or troubleshooting concept] | Lecture | +| [Insert the specific Lab scenario and Validation Checkpoints] | Lab | + +Here are my raw notes: +[INSERT YOUR RAW NOTES, CONFIG FILES, AND IDEAS HERE] +---- + +== Step 2: Validate the Output & Infrastructure Needs + +Once the AI generates your CDD, save it as `prompts/course-design.md` in your repository. Before you run the automation, quickly verify two things: + +* **The Table Structure:** Ensure the `Session Type` column strictly uses terms like `Lab` or `Lecture`. This tells the automation which file templates to use. + +== Step 3: Auto-Generate Your Repository + +With your `course-design.md` file saved, you can now run the initialization script to scaffold your entire course structure automatically! + +* **Next Step:** Review the Formating Cheat Sheet ** to see how to format your code blocks and warnings once you start writing your content. \ No newline at end of file diff --git a/modules/start_here/pages/workflow copy.adoc b/modules/start_here/pages/workflow copy.adoc deleted file mode 100644 index 5372e11..0000000 --- a/modules/start_here/pages/workflow copy.adoc +++ /dev/null @@ -1,30 +0,0 @@ -= 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] \ No newline at end of file diff --git a/modules/start_here/pages/workflow.adoc b/modules/start_here/pages/workflow.adoc index c3968a3..f6bb350 100644 --- a/modules/start_here/pages/workflow.adoc +++ b/modules/start_here/pages/workflow.adoc @@ -1,62 +1,31 @@ -= AI-Assisted Design Phase (The CDD) -:navtitle: Course Design Phase += Getting started +:navtitle: Getting started -== Skip the Blank Page Syndrome +You don't need to overplan, but you should have a plan. +Follow these high level steps to get started: -As an elite engineer, your time during this hackathon is best spent on technical execution and architecture. +. 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. -However, before you start writing AsciiDoc, you need a blueprint. We call this the **Course Design Document (CDD)**. We have an automated script (`skill.md`) that will read this CDD and automatically generate your entire GitHub repository structure, folders, and navigation map for you. +. 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. -To ensure the automation works, we ask that your CDD be in the following specific Markdown format. +. 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]. -== Step 1: The AI Generation Prompt +. 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. -The prompt below contains the specific template. You are paste it into your preferred AI assistant (e.g., ChatGPT, Claude, Red Hat Lightspeed) along with your raw technical notes. +== What Next? -[source,text] ----- -You are an expert technical instructional designer. I am going to provide you with my raw notes, terminal outputs, and code snippets for a new Red Hat AI Factory with NVIDIA technical blueprint. +Once you have completed these steps and are ready to start, you can find more guidance in the following sections: -Your task is to organize my notes into a structured Course Design Document (CDD) using STRICT Markdown formatting. The tone must be highly technical and geared toward Senior Platform Engineers and SREs. Heavily emphasize production-ready deployments, AI-first delivery methodology (using skills), and troubleshooting. - -CRITICAL: You must output the document exactly matching the schema below. Do not deviate from these heading names or the table structure, as this output will be parsed by an automated script. - -# [Insert Course Title Here] - -# COURSE GOAL -[Write a 2-3 sentence overarching goal for the blueprint] - -# TARGET AUDIENCE -[Define the primary persona, e.g., SRE, Platform Engineer] - -# PREREQUISITES -[List required prior knowledge and tools] - -# LAB INFRASTRUCTURE REQUIREMENTS -[Define hardware, required software, and pre-provisioned state. Note: Target baseline is NVIDIA Launchpad environments with dual H100 nodes unless otherwise specified.] - -# COURSE DESIGN -| Description | Session Type | -| --- | --- | -| LEARNING OBJECTIVE #1: [Insert objective here] | | -| [Insert specific hands-on task or troubleshooting concept] | Lecture | -| [Insert the specific Lab scenario and Validation Checkpoints] | Lab | -| LEARNING OBJECTIVE #2: [Insert objective here] | | -| [Insert specific hands-on task or troubleshooting concept] | Lecture | -| [Insert the specific Lab scenario and Validation Checkpoints] | Lab | - -Here are my raw notes: -[INSERT YOUR RAW NOTES, CONFIG FILES, AND IDEAS HERE] ----- - -== Step 2: Validate the Output & Infrastructure Needs - -Once the AI generates your CDD, save it as `prompts/course-design.md` in your repository. Before you run the automation, quickly verify two things: - -* **The Table Structure:** Ensure the `Session Type` column strictly uses terms like `Lab` or `Lecture`. This tells the automation which file templates to use. - -== Step 3: Auto-Generate Your Repository - -With your `course-design.md` file saved, you can now run the initialization script to scaffold your entire course structure automatically! - -* **Next Step:** Review the Formating Cheat Sheet ** to see how to format your code blocks and warnings once you start writing your content. \ No newline at end of file +* xref:course_guide:index.adoc[Course development] +* xref:lab:index.adoc[Lab development] \ No newline at end of file