Skip to content

Commit cd6725c

Browse files
committed
docs: update readme
1 parent 85f9a62 commit cd6725c

File tree

2 files changed

+20
-34
lines changed

2 files changed

+20
-34
lines changed

HOW_TO_USE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## 📚 Browse the content
44

5-
The easiest way to browse the available content is to visit the [website](https://aka.ms/moaw).
5+
The easiest way to browse the available content on the [website](https://aka.ms/moaw/catalog).
66

77
## 👩‍🏫 Conduct a workshop
88

README.md

+19-33
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,45 @@
11
# 🌳 The Mother Of All Workshops (MOAW)
22

3-
[![License: CC BY-SA 4.0](https://img.shields.io/badge/License-CC%20BY--SA-black.svg)](https://creativecommons.org/licenses/by-sa/4.0/)
4-
[![Open in Visual Studio Code](https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20in%20Visual%20Studio%20Code&labelColor=2c2c32&color=007acc&logoColor=007acc)](https://github.dev/microsoft/moaw)
3+
[![Open in Visual Studio Code](https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20in%20VS%20Code&labelColor=2c2c32&color=007acc&logoColor=007acc)](https://github.dev/microsoft/moaw)
54
[![Deploy website to GitHub Pages](https://github.com/microsoft/moaw/actions/workflows/deploy.yml/badge.svg)](https://github.com/microsoft/moaw/actions/workflows/deploy.yml)
5+
[![License: CC BY-SA 4.0](https://img.shields.io/badge/License-CC%20BY--SA-222.svg)](https://creativecommons.org/licenses/by-sa/4.0/)
66

7-
https://aka.ms/moaw
7+
Grab-and-go resources to help you learn new skills, with all the tools you need to create, host and share your own workshop.
88

9-
This repository contains workshop content about Microsoft technologies.
10-
11-
**The goal is to provide a common repository to facilitate reuse, translations, adaptations and sharing of this content. We also provide convenient tools for consuming and delivering this content.**
9+
👉 https://aka.ms/moaw
1210

1311
<div align="center">
1412
<img src="https://user-images.githubusercontent.com/593151/185623023-1175ab1f-9f55-461c-884f-9ed9723edaf3.jpg" alt="logo" />
1513
</div>
1614

17-
All the content is available under the [Creative Commons Attribution-ShareAlike 4.0 International License](#license), meaning that share and modify it any way you want, as long as you credit the original authors and keep the modified content under the same license.
18-
19-
# Usage
20-
21-
## 📚 Browse the content
22-
23-
The easiest way to browse the available content is to look at the [website](https://aka.ms/moaw/catalog).
24-
25-
## 👩‍🏫 Conduct a workshop
15+
## Usage
2616

27-
You can link to any workshop from this repository using the following URL format: `https://aka.ms/ws?src=<workshop_folder>/`
17+
### 📚 Want to learn something new?
2818

29-
**Example:** [https://aka.ms/ws?src=swa-gatsby-portfolio/](https://aka.ms/ws?src=swa-gatsby-portfolio/)
19+
Browse the available content on the [website](https://aka.ms/moaw/catalog).
3020

21+
### 👩‍🏫 Want to conduct a workshop?
3122

32-
#### Additional tips
23+
You can link to any workshop from this repository using the following URL format:
24+
`https://aka.ms/ws?src=<workshop_folder>/`
3325

34-
- You can also link to any workshop in a publicly available GitHub repository using: `https://aka.ms/ws?src=gh:<github_repo/path_to_file>`<br>
35-
This way you can adapt the content as you need in your fork and use it directly.
26+
**Example:** [https://aka.ms/ws?src=create-workshop/](https://aka.ms/ws?src=create-workshop/)
3627

37-
- You can link to a specific section of a workshop, by adding a `step` parameter and an anchor link to the URL: `&step=<section_index>#<heading_id>`
28+
For more details, see the [HOW_TO_USE](HOW_TO_USE.md#-conduct-a-workshop) guide.
3829

39-
- You can share any individual markdown-formatted page, using the URL format: `https://aka.ms/ws/page?src=<workshop_folder/path_to_file>` or `https://aka.ms/ws/page?src=gh:<github_repo/path_to_file>`<br>
40-
This is useful for sharing prerequisites, notes, etc.
30+
### 🚀 Want to create a new workshop?
4131

42-
## 📝 Adapt and modify content
32+
Follow this step-by-step tutorial for detailed instructions: [Create a workshop](https://microsoft.github.io/moaw/workshop/create-workshop/).
4333

44-
You're free to adapt, modify and localize the content of this repository to better fit your needs, as long as you keep the [license](#LICENSE) and credit the original authors.
45-
46-
The easiest way to do that is to fork this repository and make your changes in your fork. You can then link to your fork using the URL format described above.
47-
48-
If you made changes that you think would be useful to others, please also consider opening a pull request to [contribute](CONTRIBUTING.md) to this repository.
49-
50-
# Contributing
34+
## Contributing
5135

5236
All contributions are welcome, including translations, new workshops, bug fixes, etc.
5337
If you want to contribute to this repository, please read the [contributing guidelines](CONTRIBUTING.md).
5438

55-
# License
39+
## License
5640

5741
[![Creative Commons License](https://i.creativecommons.org/l/by-sa/4.0/88x31.png)](http://creativecommons.org/licenses/by-sa/4.0/)
5842

59-
This work is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/").
43+
All workshop content is available under the [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/), meaning that you can share and modify it any way you want, as long as you credit the original authors and keep the modified content under the same license.
44+
45+
The source code of the various tools is available under the [MIT License](packages/website/LICENSE).

0 commit comments

Comments
 (0)