{"id":27256020,"url":"https://github.com/redhatquickcourses/instructlabforacademica","last_synced_at":"2025-04-11T02:49:02.431Z","repository":{"id":284536286,"uuid":"955252724","full_name":"RedHatQuickCourses/InstructLabForAcademica","owner":"RedHatQuickCourses","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-26T10:59:58.000Z","size":924,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-26T12:21:25.304Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://redhatquickcourses.github.io/InstructLabForAcademica/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RedHatQuickCourses.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-26T10:56:24.000Z","updated_at":"2025-03-26T11:00:39.000Z","dependencies_parsed_at":"2025-03-26T12:21:26.602Z","dependency_job_id":"f23d3b22-9d92-420a-9c26-e615c0198729","html_url":"https://github.com/RedHatQuickCourses/InstructLabForAcademica","commit_stats":null,"previous_names":["redhatquickcourses/instructlabforacademica"],"tags_count":0,"template":false,"template_full_name":"RedHatQuickCourses/template-showroom","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedHatQuickCourses%2FInstructLabForAcademica","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedHatQuickCourses%2FInstructLabForAcademica/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedHatQuickCourses%2FInstructLabForAcademica/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedHatQuickCourses%2FInstructLabForAcademica/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RedHatQuickCourses","download_url":"https://codeload.github.com/RedHatQuickCourses/InstructLabForAcademica/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248332626,"owners_count":21086101,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-04-11T02:49:01.942Z","updated_at":"2025-04-11T02:49:02.408Z","avatar_url":"https://github.com/RedHatQuickCourses.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"=== Getting Started\n\nThis template is designed to be used as a base for your showroom lab guides.\n\nThe content is built using Antora, a static site generator for creating documentation sites from AsciiDoc documents.\n\nThis git repo template was created to make it easy for you to start developing your lab instructions.\n\nFeatures:\n\n. 0% cruft\n. Red Hat Demo Platform UI Bundle default\n. Dev Mode extension that displays the asciidoc attributes you have to work with\n. Content is generated using Antora, a static site generator for creating documentation sites from AsciiDoc documents.\n\n== Getting Started\n\n=== Using Containers (Recommended)\n\nIn order to test and develop on your local machine, you can use a specially built container with Podman or Docker as follows.\n\n. Create a git repo from this template\n.. Suggested naming: `showroom_\u003clab-name\u003e`\n. Clone your new repo and `cd` into it\n. When you make changes to the content, all you need is to kill the container and run it again.\n+\n[source,sh]\n----\npodman run --rm --name antora -v $PWD:/antora -p 8080:8080 -i -t ghcr.io/juliaaano/antora-viewer\n----\n\nFor SELinux environments, `:z` may need to be appended to the volume mount:\n\n----\npodman run --rm --name antora -v $PWD:/antora:z -p 8080:8080 -i -t ghcr.io/juliaaano/antora-viewer\n----\n\nLive-reload is not supported.\n\n=== Using Local Files (Less Recommended)\n\n. Create a git repo from this template\n. Clone the repo and `cd` into it\n. Run ./utilities/lab-serve\n. Open http://localhost:8080 in your browser\n. Run ./utilities/lab-build to build your html\n\nTo rebuild your html, run `./utilites/build`.\n\n== Editing Files\n\nNow you are ready to go!\nYou can start editing the files in the `content/modules/ROOT/pages/` directory.\n\nMany modern editors such as Visual Studio Code offer live Asciidoc Preview extensions.\n\n=== Understanding the Basic Template Directory Structure\n\n[source,sh]\n----\n./content/modules/ROOT/\n├── assets\n│   └── images                       # Images used in your content\n│       └── example-image.png\n├── examples                         # You can add downloadable assets here\n│   └── example-bash-script.sh       # e.g. an example bash script\n├── nav.adoc                         # Navigation for your lab\n├── pages                            # Your content goes here\n│   ├── index.adoc                   # First page of your lab, e.g. overview etc\n│   ├── module-01.adoc\n│   └── module-02.adoc               # Sample lab has 2 modules including index.adoc\n└── partials                         # You can add partials here, reusable content inserted inline into your modules\n    └── example_partial.adoc\n----\n\n== Adding Additional Links\n\nYou can add links to external content in the convenient \"Links\" drop-down on the upper-right of the Showroom Summit 2024 UI.\n\n../content/antora.yml\n[source,yaml]\n----\nasciidoc:\n  attributes:\n    page-links:\n    - url: https://redhat.com\n      text: Red Hat\n----\n\nimage::ui-links.png[]\n\n== Dev Mode\n\nAs a convenience to developers, the Dev Mode Extention (disabled by default) displays the asciidoc attributes you have to work with while writing your lab instructions.\n\n. Disable/Enable Dev Mode by changing `enabled: true` or `enabled: false`\n+\n.default-site.yml\n[source,yaml]\n----\nextensions:\n  - id: dev-mode\n    require: ./content/lib/dev-mode.js\n    enabled: false\n----\n\n. Produces\n+\nimage::dev-mode.png[]\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredhatquickcourses%2Finstructlabforacademica","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fredhatquickcourses%2Finstructlabforacademica","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredhatquickcourses%2Finstructlabforacademica/lists"}