This repository has been archived by the owner on Sep 22, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Comply with Community Standards (#123)
* Added Community documentation * Remove .github README and update presenter notes * Update due to migration of retaildevcrews content to cse-labs
- Loading branch information
Showing
11 changed files
with
184 additions
and
86 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Microsoft Open Source Code of Conduct | ||
|
||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
|
||
Resources: | ||
|
||
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/) | ||
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) | ||
- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
# 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 [Microsoft CLA](https://cla.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., label, 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. | ||
|
||
- [Code of Conduct](#coc) | ||
- [Issues and Bugs](#issue) | ||
- [Feature Requests](#feature) | ||
- [Submission Guidelines](#submit) | ||
|
||
## Code of Conduct | ||
|
||
Help us keep this project open and inclusive. Please read and follow our [Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
|
||
## Found an Issue | ||
|
||
If you find a bug in the source code or a mistake in the documentation, you can help us by | ||
[submitting an issue](#submit-issue) to the GitHub Repository. Even better, you can | ||
[submit a Pull Request](#submit-pr) with a fix. | ||
|
||
## Want a Feature | ||
|
||
You can *request* a new feature by [submitting an issue](#submit-issue) to the GitHub | ||
Repository. If you would like to *implement* a new feature, please submit an issue with | ||
a proposal for your work first, to be sure that we can use it. | ||
|
||
- **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr). | ||
|
||
## Submission Guidelines | ||
|
||
### Submitting an Issue | ||
|
||
Before you submit an issue, search the archive, maybe your question was already answered. | ||
|
||
If your issue appears to be a bug, and hasn't been reported, open a new issue. | ||
Help us to maximize the effort we can spend fixing issues and adding new | ||
features, by not reporting duplicate issues. Providing the following information will increase the | ||
chances of your issue being dealt with quickly: | ||
|
||
- **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps | ||
- **Version** - what version is affected (e.g. 0.1.2) | ||
- **Motivation for or Use Case** - explain what are you trying to do and why the current behavior is a bug for you | ||
- **Browsers and Operating System** - is this a problem with all browsers? | ||
- **Reproduce the Error** - provide a live example or a unambiguous set of steps | ||
- **Related Issues** - has a similar issue been reported before? | ||
- **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be | ||
causing the problem (line of code or commit) | ||
|
||
You can file new issues by providing the above information at the corresponding repository's issues link: `https://github.com/cse-labs/k8s-quickstart/issues/new]` | ||
|
||
### Submitting a Pull Request (PR) | ||
|
||
Before you submit your Pull Request (PR) consider the following guidelines: | ||
|
||
- Search the repository `https://github.com/cse-labs/k8s-quickstart/pulls` for an open or closed PR | ||
that relates to your submission. You don't want to duplicate effort. | ||
|
||
- Make your changes in a new git fork: | ||
|
||
- Commit your changes using a descriptive commit message | ||
- Push your fork to GitHub: | ||
- In GitHub, create a pull request | ||
- If we suggest changes then: | ||
- Make the required updates. | ||
- Rebase your fork and force push to your GitHub repository (this will update your Pull Request): | ||
|
||
```shell | ||
|
||
git rebase main -i | ||
git push -f | ||
|
||
``` | ||
|
||
That's it! Thank you for your contribution! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,72 @@ | ||
# Notes for Presentation Recordings | ||
# Information for Presenters | ||
|
||
## While preparing content | ||
This document has two goals. | ||
|
||
* Make a note of long running steps that can be executed before the live presentation. Include this list of steps in the invitation. | ||
* How to open repository with Codespaces | ||
* Logging into Azure and setting a subscription | ||
1. Help people manage their session from idea to presentation. | ||
2. Collect best practices for presentations. | ||
|
||
## Before starting presentation call | ||
## Types of Presentations | ||
|
||
* Adjust your resolution. Sharing widescreens sucks for those that don’t have wide screens – pretty unreadable | ||
* Set your font to a readable size | ||
* Color blindness is common – choose a color scheme that is inclusive | ||
* Close unused windows / tabs to avoid “alt-tab hell” | ||
These are some ideas for the types of sessions you can choose from here. You can also choose a different style that is a better fit for your content. | ||
|
||
## Before starting recording | ||
- Hands-On sessions | ||
- Presenter provides instructions in a repo where audience can follow along | ||
- Demo + Q&A | ||
- Showcase a feature or topic. At the end, take questions about the content. | ||
- In-Depth presentations | ||
- Presenter expands on a specific topic. Providing in-depth details about the topic. | ||
|
||
* Mic check | ||
* Share your screen and ask if it’s readable | ||
## Logistics for the Session Preparation | ||
|
||
## During presentation | ||
- Pick a session idea, or add one to the [project board](https://github.com/orgs/cse-labs/projects/1) | ||
- Assign the presenters to the issue. | ||
- Work with your team during sprints to schedule. | ||
- Create calendar invite and invite team members. | ||
- Usual times are Tuesdays and Thursdays from 3:30 PM to 4:30 PM Central. But this is flexible. | ||
- Create a [retro link here](https://rdc-retro.azurewebsites.net/) for people to give feedback about your session. | ||
- After session, upload video to Stream. | ||
|
||
* “Quiet Mouse” – only move your mouse / scroll your screen when necessary (not as a nervous tick) | ||
* Scroll __s__ __l__ __o__ __w__ __l__ __y__ and avoid over-scrolling and having to scroll back up | ||
## How to Upload Videos to Stream | ||
|
||
- "[Uploading Videos to Stream](https://msit.microsoftstream.com/video/92e5a3ff-0400-85a8-becc-f1eb87532a60)" video in the [Stream channel](https://aka.ms/rdc-demos). | ||
|
||
Steps: | ||
|
||
- Open recording in Stream. | ||
- Update video details. | ||
- Enable "Allow everyone in your company to view this video" if video is not team confidential. | ||
- Shared with appropriate "RDC-*" channel. Choose "Channels", then search for "rdc". | ||
- Make RDC group an owner. Choose "My groups", then search for "rdc" again. | ||
- Enable the "Owner" option for the RDC group. | ||
- Click "Apply". | ||
|
||
## Peparing Content | ||
|
||
- It is helpful to partner with someone to present a topic. | ||
- Have 2 or 3 key learnings for the audience to take away from the session. | ||
- Some topics benefit from learning with the end in mind. Give the audience an ideal end state, then work towards it in the presentation. | ||
- Make a note of long running steps that can be executed before the live presentation. Include this list of steps in the invitation. | ||
- How to open repository with Codespaces | ||
- Logging into Azure and setting a subscription | ||
|
||
## Before Starting the Presentation Call | ||
|
||
- Adjust your resolution. Sharing widescreens sucks for those that don’t have wide screens – pretty unreadable | ||
- Set your font to a readable size | ||
- Color blindness is common – choose a color scheme that is inclusive | ||
- Close unused windows / tabs to avoid “alt-tab hell” | ||
|
||
## Before Starting Recording | ||
|
||
- Mic check | ||
- Share your screen and ask if it’s readable | ||
|
||
## During Presentation | ||
|
||
- “Quiet Mouse” – only move your mouse / scroll your screen when necessary (not as a nervous tick) | ||
- Scroll __s__ __l__ __o__ __w__ __l__ __y__ and avoid over-scrolling and having to scroll back up | ||
- Double check that mic is working and people can hear you. | ||
|
||
## End of presentation | ||
|
||
* Plan your close and close quickly – “No more questions? Thanks for attending – recording is here. Bye.” | ||
- Plan your close and close quickly – “No more questions? Thanks for attending – recording is here. Bye.” |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
MIT License | ||
|
||
Copyright (c) Microsoft Corporation. | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters