⚙️ moaw-workshop-aio-template

This repository contains an all-in-one template for creating a MOAW workshop.

This template includes the following:

Built-in MOAW workshop documentation, located in the docs folder.
A GitHub Actions workflow for automatically creating the workshop template in the main branch (the reference branch used is the base branch).
A GitHub Actions workflow for automatically creating packages for the workshop (for intermediate steps, solution, etc).

How to use this template

Initial setup

Click the Use this template button on GitHub to create a new repository from this template.
Name your repository and click Create repository from template.
Go to your repository settings, and rename your default branch from main to base.

Creating your workshop

From this point, you can start creating your workshop content in the base branch. The following are some of the steps you can take to customize your workshop:

Update the docs folder with your workshop content. See this link for more information on how to author your workshop content.
Update the .devcontainer folder with your workshop environment.
Update the scripts/create-github-template.sh script to create the GitHub template for your workshop (see TODO: notes in the script).
Update the scripts/create-packages.sh script to create packages for your workshop (see TODO: notes in the script).

To make it easier to edit your workshop docs, you can use the MOAW CLI:

Run moaw serve to preview your workshop content locally, with live reload.
Run moaw link docs/workshop.md once your workshop is complete to generate a shareable link to your workshop.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks