{"id":13942021,"url":"https://github.com/OpenLiberty/cloud-hosted-guides","last_synced_at":"2025-07-20T05:31:46.886Z","repository":{"id":37085812,"uuid":"244659160","full_name":"OpenLiberty/cloud-hosted-guides","owner":"OpenLiberty","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-02T21:50:35.000Z","size":8346,"stargazers_count":2,"open_issues_count":21,"forks_count":10,"subscribers_count":4,"default_branch":"prod","last_synced_at":"2025-07-02T22:31:36.629Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OpenLiberty.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2020-03-03T14:34:54.000Z","updated_at":"2025-07-02T21:37:28.000Z","dependencies_parsed_at":"2023-10-14T18:10:57.866Z","dependency_job_id":"b5c35eee-8326-4681-a328-86d0833eef81","html_url":"https://github.com/OpenLiberty/cloud-hosted-guides","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/OpenLiberty/cloud-hosted-guides","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenLiberty%2Fcloud-hosted-guides","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenLiberty%2Fcloud-hosted-guides/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenLiberty%2Fcloud-hosted-guides/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenLiberty%2Fcloud-hosted-guides/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenLiberty","download_url":"https://codeload.github.com/OpenLiberty/cloud-hosted-guides/tar.gz/refs/heads/prod","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenLiberty%2Fcloud-hosted-guides/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266071519,"owners_count":23871940,"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":"2024-08-08T02:01:39.911Z","updated_at":"2025-07-20T05:31:41.855Z","avatar_url":"https://github.com/OpenLiberty.png","language":"Jupyter Notebook","funding_links":[],"categories":["Jupyter Notebook"],"sub_categories":[],"readme":"# cloud-hosted-guides\nA temp repo to store instructions and other artifacts in regards to our Quick Labs and Workshops\n\n# Mirror Instructions\nAll of the folders under `https://github.com/OpenLiberty/cloud-hosted-guides/tree/master/instructions/` have a matching Gitlab repository used for SkillsNetwork labs.\nWhen creating a new cloud-hosted-guides guide some steps must be taken to ensure that future changes will be mirrored.\n\n## Step-by-Step Instructions\n\n### Step 1: Create the QuickLab\n\n1. **Create a New Project:**\n\n- Navigate to the SkillsNetwork Author portal at [Become an Author](https://skills.network/authors).\n- Follow the process to [create a Guided Project in Author Workbench](https://author.skills.network/quicklabs/new?how_to_continue=true)\n\n### Step 2: Add Collaborators\n\n1. **Access Your QuickLab:**\n   - Go to your QuickLab page: `https://author.skills.network/quicklabs/:id?show=team`.\n\n2. **Invite Team Members:**\n   - Click on \"Invite Member.\"\n   - Search for @Gilbert's email and add him as an `Admin` or `Instructor`.\n\n### Step 3: Prepare Instruction Templates\n\n1. **Duplicate the Template Folder:**\n   - Copy and rename the `cloud-hosted-guide-template` folder under `instruction-templates` to and change the folder name to match your QuickLab name.\n   - Keep the original `instructions.md` filename as it will be the file used for editing content.\n\n### Step 4: Update Configuration\n\n1. **Modify the `mirror.json` and `StagingMirror.json` File:**\n   - Add a new entry to the `mirror.json` and `StagingMirror.json` file using the following format:\n\n   ```json\n   {\n     \"guide\": \"name-of-your-quicklab\",\n     \"github\": \"the-folder-name\",\n     \"quick_lab_id\": \"quicklab_id\",\n     \"lab_id\": \"lab_id\"\n   }\n\n2. **Locate QuickLab and Lab IDs:**\n\n- Find the QuickLab ID from the URL: https://author.skills.network/quicklabs/:quicklab_id.\n- To find the Lab ID, navigate to the Labs tab, hover over the lab, and note the Lab ID from the URL shown at the bottom left of your screen: https://author.skills.network/labs/:lab_id.\n- Update the mirror.json with these IDs.\n\n\n### Step 5: Deploy Your Changes\n\n1. **Mirror Guide Setup:**\n\n- Initiate a `Mirror a guide to AWB` action.\n- Enter the `Guide name` and `To` Options\n- - For `To`, `prod` for publishing the lab to the world, `staging` for saving the lab without publishing.\n\n## How to Contribute\n\nTo contribute to this project, please follow these steps:\n\n1. **Create a Pull Request (PR):**\n   - Always create a pull request targeting the `staging` branch when you wish to make updates. This is where all initial changes should be made and reviewed.\n\n2. **Review Process:**\n   - Have someone review your content changes in the `staging` branch. This ensures all updates meet the project's standards and requirements before they are deployed.\n\n3. **Deploy to Staging:**\n   - Use the `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.\n\n4. **Approval and Merging:**\n   - Once your changes are reviewed and approved in the `staging` branch, merge them into the `prod` branch.\n\n5. **Publish to Production:**\n   - After merging to `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.\n\nFollowing this workflow ensures a structured and error-minimized deployment of content, maintaining high standards of quality and consistency.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOpenLiberty%2Fcloud-hosted-guides","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOpenLiberty%2Fcloud-hosted-guides","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOpenLiberty%2Fcloud-hosted-guides/lists"}