Skip to content
This repository was archived by the owner on Oct 27, 2023. It is now read-only.
Open
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
3 changes: 2 additions & 1 deletion .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"recommendations": [
"asciidoctor.asciidoctor-vscode"
"asciidoctor.asciidoctor-vscode",
"vscodevim.vim"
]
}
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,9 @@
# Red Hat OpenShift Data Science Quick Course

Welcome to the OpenShift Data Science quick course!. This course uses standard asciidoc for content authoring that is then rendered to HTML and hosted by GitHub Pages. It uses the Antora publishing platform (https://antora.org) to transform the asciidoc conent to HTML.
Welcome to the OpenShift Data Science quick course! This course uses standard asciidoc for content authoring that is then rendered to HTML and hosted by GitHub Pages. It uses the Antora publishing platform (https://antora.org) to transform the asciidoc conent to HTML.

To contribute, you can use locally installed tooling on your workstation, or you can use OpenShift DevSpaces to work with content using a web based IDE without the need to install anything.

## Locally installed Tooling

1. Install an LTS version of the Node.js runtime on your workstation.
2. Clone this Git repository to a folder of your choice. For the following steps in this README, this folder is indicated by *$CONTENT_ROOT*.
3. Install an editor of your choice. We recommend Visual Studio Code with the *asciidoctor* plug-in.
4. Follow the steps in the *Previewing HTML content and publishing* section.

## The "Easy Button" aka OpenShift DevSpaces

1. To open and edit the asciidoc files in OpenShift DevSpaces, click on the **Developer Workspace** badge below and log in using your provided OpenShift credentials:
Expand All @@ -19,11 +12,18 @@ To contribute, you can use locally installed tooling on your workstation, or you

2. If you launch the DevSpaces workspace for the first time, it will take a few minutes to download the container image, clone the Git repository, and set up your project. All the required tooling and IDE plugins are automatically installed and set up for you.

3. Follow the steps in the *Previewing HTML content and publishing* section.
3. Follow the steps in the [*Previewing HTML content and publishing*](#Previewing-HTML-content-and-publishing) section.

## Locally installed Tooling

1. Install an LTS version of the Node.js runtime on your workstation.
2. Clone this Git repository to a folder of your choice. For the following steps in this README, this folder is indicated by *$CONTENT_ROOT*.
3. Install an editor of your choice. We recommend Visual Studio Code with the *asciidoctor* plug-in.
4. Follow the steps in the [*Previewing HTML content and publishing*](#Previewing-HTML-content-and-publishing) section.

## Previewing HTML content and publishing

1. All commands in the following steps are to be run from the *$CONTENT_ROOT* folder. Navigate to this folder from the VSCode terminal (Press **Ctrl + `**):
1. All commands in the following steps are to be run from the *$CONTENT_ROOT* folder. Navigate to this folder from the VSCode terminal (Press **"Ctrl + \`"** on Linux; Press **"Ctrl + Shift + `"** on MacOS):

```bash
$ cd $CONTENT_ROOT
Expand All @@ -35,13 +35,13 @@ $ cd $CONTENT_ROOT
$ npm install
```

3. The Git repository contains the default chapter and section stubs with comments from the product owner/architect to help guide you. Inspect the *$CONTENT_ROOT/antora.yml* file, which defines the top level modules (chapters) in this course.
3. The Git repository contains the default chapter and section stubs with comments from the course product owner and architect to help guide you. Inspect the *$CONTENT_ROOT/antora.yml* file, which defines the top level modules (chapters) in this course.

4. The starting point (index page) for the course is rendered from asciidoc content in the *$CONTENT_ROOT/modules/ROOT/pages/index.adoc* file.

5. Each top level module has a separate asciidoc file (*nav.adoc*) located in *$CONTENT_ROOT/modules/module_name/* folder. The *nav.adoc* lists the sections that make up the chapter/module.

6. Edit the asciidoc files under *$CONTENT_ROOT/modules/module_name/pages* folder for writing lectures and hands-on lab content as per the outline provided by the course architect/peoduct owner. You can use the *asciidoctor* plug-in preview plugin (Press *"Ctrl + Shift + V"* in VSCode) to preview the rendered HTML content.
6. To write narrative and hands-on lab content, edit the asciidoc files under *$CONTENT_ROOT/modules/module_name/pages*. You can use the *asciidoctor* plug-in preview plugin (Press **"Ctrl + Shift + V"** on Linux; Press **"Cmd + Shift + V"** on MacOS) to preview the rendered HTML content.

7. To preview the rendered website as it would look for end-users consuming this content, do the following:

Expand All @@ -60,8 +60,11 @@ $ npm install

* Keep making changes in your asciidoc source files. The **npm watch** command will automatically detect your changes and re-generate the HTML content. Refresh your web browser to view the updated content

8. Once you are satisfied with how the HTML content is rendered locally in your workspace, you can commit your changes and do a **git push** to push your content to the **main** branch of the course Git repository. An automated GitHub action runs on every push to the **main** branch and updates the HTML content in GitHub Pages.
8. Once you are satisfied with how the HTML content is rendered locally in your workspace, you can commit your changes and do a **git push** to your branch.

9. Open a Pull Request so that the changes in your branch can be merged into the **main** branch of the course Git repository. A GitHub action runs on every merge & push to the **main** branch and publishes the HTML content to a GitHub Page.

9. After a few minutes, the GitHub action finishes and you can view the latest rendered asciidoc content at https://rsriniva.github.io/rhods-quick-course.

10. If you run into any issues, report bugs/suggestions/improvements about this course here - https://github.com/rsriniva/rhods-quick-course/issues
## Problems and Feedback
If you run into any issues, report bugs/suggestions/improvements about this course here - https://github.com/RedHatTraining/rhods-quick-course/issues
1 change: 1 addition & 0 deletions modules/intro/pages/intro.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ video::Y12T8G1LpyY[youtube,title=Demo: Introduction to RHODS,width=640,height=48
=== References

* https://developers.redhat.com/learn/openshift-data-science[Red Hat Developers page for RHODS]
Nate was here.