Skip to content

Commit

Permalink
RHODS intro course skeleton
Browse files Browse the repository at this point in the history
  • Loading branch information
rsriniva committed Oct 10, 2023
1 parent 9fe38fa commit 4b5c7be
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 25 deletions.
24 changes: 5 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,9 @@
# Red Hat OpenShift Data Science Quick Course
# Introduction to Red Hat OpenShift Data Science

This is the starter template for creating a new quick course in the **RedHatQuickCourses** GitHub organization.
This is the first in a series of 6 courses about Red Hat OpenShift Data Science (RHODS).
This foundational courses introduces the features, use-cases, concepts, terminology and the architecture of the product.

After you create a new repository based on this template, you need to edit and change several files and replace placeholder text and links in them.

1. Add a _README_ at the root of your repository and leave instructions for people contributing to your quick course. Make sure you provide the link to the GitHub issues page for your course so that contributors and users can report issues and provide feedback about your course.

1. Edit the **antora.yml** file in the repository root.
* Change the _name_, _title_ and _version_ attributes
* Edit the list of items under the _nav_ attribute to add or remove new chapters/modules to the course.

1. Edit the antora-playbook.yml file in the repository root.
* Edit only the _title_ and _start_page_ attributes in this file. You may not be required to change the other attributes unless the need arises.

1. Edit the _supplemental-ui/partials/header-content.hbs_ file and change the link in the _navbar-item_ div to point to the GitHub issues page for your repository.

1. Edit the files and folders under the _modules_ folder to structure your course content into chapters/modules and sections.

1. Take a brief look at the GitHub actions configuration in the _.github_ folder. It contains basic configuration to auto-generate HTML from the asciidoc source and render it using GitHub pages. Unless you know what you are doing with this, and have prior experience with GitHub actions workflows, do not change these files.
Refer to the quick courses [contributor guide](https://redhatquickcourses.github.io/welcome/1/guide/overview.html) to work with this repository.

## Problems and Feedback
If you run into any issues, report bugs/suggestions/improvements about this template here - https://github.com/RedHatQuickCourses/course-starter/issues
If you run into any issues, report bugs/suggestions/improvements about this course here - https://github.com/RedHatQuickCourses/rhods-intro/issues
4 changes: 2 additions & 2 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
site:
title: Placeholder Course Title
start_page: placeholder-course-name::index.adoc
title: Introduction to Red Hat OpenShift Data Science
start_page: rhods-intro::index.adoc

content:
sources:
Expand Down
6 changes: 3 additions & 3 deletions antora.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: placeholder-course-name
title: Placeholder Course Title
version: 1
name: rhods-intro
title: Introduction to Red Hat OpenShift Data Science
version: 1.33
nav:
- modules/ROOT/nav.adoc
- modules/chapter1/nav.adoc
Expand Down
2 changes: 1 addition & 1 deletion supplemental-ui/partials/header-content.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
</div>
<div id="topbar-nav" class="navbar-menu">
<div class="navbar-end">
<a class="navbar-item" href="https://github.com/RedHatQuickCourses/changeme/issues" target="_blank">Report Issues</a>
<a class="navbar-item" href="https://github.com/RedHatQuickCourses/rhods-intro/issues" target="_blank">Report Issues</a>
</div>
</div>
</nav>
Expand Down

0 comments on commit 4b5c7be

Please sign in to comment.