Skip to content

Latest commit

 

History

History
81 lines (54 loc) · 4.44 KB

README.md

File metadata and controls

81 lines (54 loc) · 4.44 KB
Raw

Red Hat OpenShift Dev Spaces Administration

This course is the second in a series of 5 courses about Red Hat OpenShift Dev Spaces. This course covers how to install, update and uninstall Red Hat OpenShift Dev Spaces and perform basic administration tasks.

Creating Course Content

We use a system called Antora (https://antora.org) to publish courses. Antora expects the files and folders in a source repository to be arranged in a certain opinionated way to simplify the process of writing course content using asciidoc, and then converting the asciidoc source to HTML.

Refer to the quick courses contributor guide for a detailed guide on how to work with Antora tooling and publish courses.

TL;DR Quickstart

This section is intended as a quick start guide for technically experienced members. The contributor guide remains the canonical reference for the course content creation process with detailed explanations, commands, video demonstrations, and screenshots.

Pre-requisites

  • You have a macOS or Linux workstation. Windows has not been tested, or supported. You can try using a WSL2 based environment to run these steps - YMMV!
  • You have a somewhat recent version of the Git client installed on your workstation
  • You have a somewhat new Node.js LTS release (Node.js 16+) installed locally.
  • Install a recent version of Visual Studio Code. Other editors with asciidoc editing support may work - YMMV, and you are on your own...

Antora Files and Folder Structure

The antora.yml file lists the chapters/modules/units that make up the course.

Each chapter entry points to a nav.adoc file that lists the sections in that chapter. The home page of the course is rendered from modules/ROOT/pages/index.adoc.

Each chapter lives in a separate folder under the modules directory. All asciidoc source files live under the modules/CHAPTER/pages folder.

To create a new chapter in the course, create a new folder under modules.

To add a new section under a chapter create an entry in the modules/CHAPTER/nav.adoc file and then create the asciidoc file in the modules/CHAPTER/pages folder.

Steps

  1. Clone or fork the course repository.
    $ git clone git@github.com:RedHatQuickCourses/devspaces-admin.git
  1. Install the npm dependencies for the course tooling.
    $ cd devspaces-admin
    $ npm install
  1. Start the asciidoc to HTML compiler in the background. This command watches for changes to the asciidoc source content in the modules folder and automatically re-generates the HTML content.
    $ npm run watch:adoc
  1. Start a local web server to serve the generated HTML files. Navigate to the URL printed by this command to preview the generated HTML content in a web browser.
    $ npm run serve
  1. Before you make any content changes, create a local Git branch based on the main branch. As a good practice, prefix the branch name with your GitHub ID. Use a suitable branch naming scheme that reflects the content you are creating or changing.
    $ git checkout -b rsriniva/ch01s01
  1. Make your changes to the asciidoc files. Preview the generated HTML and verify that there are no rendering errors.Commit your changes to the local Git branch and push the branch to GitHub.
    $ git add .
    $ git commit -m "Added lecture content for chapter 1 section 1"
    $ git push -u origin rsriniva/ch01s01

  1. Create a GitHub pull request (PR) for your changes using the GitHub web UI. For forks, create a PR that merges your forked changes into the main branch of this repository.

  2. Request a review of the PR from your technical peers and/or a member of the PTL team.

  3. Make any changes requested by the reviewer in the same branch as the PR, and then commit and push your changes to GitHub. If other team members have made changes to the PR, then do not forget to do a git pull before committing your changes.

  4. Once reviewer(s) approve your PR, you should merge it into the main branch.

  5. Wait for a few minutes while the automated GitHub action publishes your changes to the production GitHub pages website.

  6. Verify that your changes have been published to the production GitHub pages website at https://redhatquickcourses.github.io/devspaces-admin

Problems and Feedback

If you run into any issues, report bugs/suggestions/improvements about this course here - https://github.com/RedHatQuickCourses/devspaces-admin/issues