https://github.com/sinedied/moaw-workshop-aio-template
All-in-one template for creating a MOAW workshop
https://github.com/sinedied/moaw-workshop-aio-template
Last synced: about 2 months ago
JSON representation
All-in-one template for creating a MOAW workshop
- Host: GitHub
- URL: https://github.com/sinedied/moaw-workshop-aio-template
- Owner: sinedied
- License: mit
- Created: 2024-02-27T12:35:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-27T14:01:05.000Z (over 1 year ago)
- Last Synced: 2025-08-20T07:42:47.741Z (about 2 months ago)
- Language: Shell
- Homepage:
- Size: 17.6 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Support: SUPPORT.md
Awesome Lists containing this project
README
# ⚙️ moaw-workshop-aio-template
This repository contains an all-in-one template for creating a [MOAW](https://moaw.dev) 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
1. Click the `Use this template` button on GitHub to create a new repository from this template.
2. Name your repository and click `Create repository from template`.
3. 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](https://moaw.dev/workshop/create-workshop/?step=2#edit-the-workshop-metadata) 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](https://github.com/microsoft/moaw/tree/main/packages/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](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## Trademarks
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
trademarks or logos is subject to and must follow
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
Any use of third-party trademarks or logos are subject to those third-party's policies.