This is the starter template for creating a new quick course in the RedHatQuickCourses GitHub organization.
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.
-
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.
-
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.
-
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.
-
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.
-
Edit the files and folders under the modules folder to structure your course content into chapters/modules and sections.
-
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.
If you run into any issues, report bugs/suggestions/improvements about this template here - https://github.com/RedHatQuickCourses/course-starter/issues