A temp repo to store instructions and other artifacts in regards to our Quick Labs and Workshops
All of the folders under https://github.com/OpenLiberty/cloud-hosted-guides/tree/master/instructions/
have a matching Gitlab repository used for SkillsNetwork labs.
When creating a new cloud-hosted-guides guide some steps must be taken to ensure that future changes will be mirrored.
Access Your QuickLab:
https://author.skills.network/quicklabs/:id?show=team
.Invite Team Members:
Admin
or Instructor
.cloud-hosted-guide-template
folder under instruction-templates
to and change the folder name to match your QuickLab name.instructions.md
filename as it will be the file used for editing content.Modify the mirror.json
and StagingMirror.json
File:
mirror.json
and StagingMirror.json
file using the following format:
{
"guide": "name-of-your-quicklab",
"github": "the-folder-name",
"quick_lab_id": "quicklab_id",
"lab_id": "lab_id"
}
Locate QuickLab and Lab IDs:
Mirror a guide to AWB
action.Guide name
and To
OptionsTo
, prod
for publishing the lab to the world, staging
for saving the lab without publishing.To contribute to this project, please follow these steps:
Create a Pull Request (PR):
staging
branch when you wish to make updates. This is where all initial changes should be made and reviewed.Review Process:
staging
branch. This ensures all updates meet the project's standards and requirements before they are deployed.Deploy to Staging:
Mirror a guide to AWB
GitHub Action to deploy your updates to staging. Set the deployment target by selecting staging
in the action's inputs. This step saves the content on the Author Workbench (AWB) side for further review.Approval and Merging:
staging
branch, merge them into the prod
branch.Publish to Production:
prod
, use the Mirror a guide to AWB
GitHub Action again to publish your content. Set the To
parameter to prod
to finalize the publication on the production environment.Following this workflow ensures a structured and error-minimized deployment of content, maintaining high standards of quality and consistency.