Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add onboarding request template #1016

Merged
merged 3 commits into from
Sep 14, 2023
Merged

Conversation

tecton
Copy link
Contributor

@tecton tecton commented Sep 6, 2023

Effect Preview:
image

@HuihuiWu-Microsoft
Copy link
Contributor

  1. What about making it as a table so as to be more clear?
  2. I think some of the fields are for sample owner to fill like 'onboard date' since they don't know our release schedule, can we separate these two parts, one part is for sample owner to fill, another is for us to fill like onboarding date, PM contact, ...
  3. The template should also contain information like onboarding pull requests of the sample source code?

@tecton
Copy link
Contributor Author

tecton commented Sep 6, 2023

  1. What about making it as a table so as to be more clear?
  2. I think some of the fields are for sample owner to fill like 'onboard date' since they don't know our release schedule, can we separate these two parts, one part is for sample owner to fill, another is for us to fill like onboarding date, PM contact, ...
  3. The template should also contain information like onboarding pull requests of the sample source code?
  1. Personally, I think table is not friendly to authors especially when there are multiple columns, they are pretty in "preview" mode but a bit more complex in "edit" mode.
  2. I'm not sure whether we should make these internal fields available here because they are not for sample owners to fill.
  3. Yes, I'll add the pull request field.

@summzhan
Copy link
Contributor

  1. No need to be table from eady editing perspectives, can keep current format.
  2. fileds that are internal, not require user to provide could hide from template. Fileds that need user inputs are following: Sample Onboard Request template

[Required field] ID: {Replace with your sample ID} (e.g. "hello-world-sample")
[Required field] Title: {Replace with your sample name} (e.g. "Hello World Sample")
[Required field] Description: {Replace with one or two sentence that introduce this sample}
[Required field] Tags: {Sample labels}
You can give your samples a set of tags so that users can easily locate your sample from a group of samples. Those tags can be:
the programming languages you used, e.g. "JS", "TS", "C#" etc.
the Teams app type, e.g. "Tab", "Bot", "Message Extension" etc.
the highlighted technics you used, e.g. "React", "Azure Function", "Graph Toolkit", "Teams AI SDK", "Live Share SDK" etc.
the business scenarios of your sample, e.g. "Team Dashboard", "Productivity", "Notification", "Q&A" etc.
You can customize the tag you used for your sample, the recommended number of tags is less than 5.
[Required field] Time: {The estimation time to run the sample} (e.g. "5mins to run")
[Required field] Configuration: {does the sample require additional manual steps to config before it can run} (value: "Ready for local debug"/"Manual configurations required")
[Required field] Screenshot/Gif: {the file path where you put the gif/pics, typically it's in assets folder but you can put it anywhere you want.}
Suggested size of gif/pic is 1600x920/800x460 (If you have it with other sizes, please keep same image ratio for other sizes and don't forget to consider the resolution. Your gif or pics must fit the entire Teams client UI into the image.
[Required field] SourceCode PR:
[Optional field] SampleUrl: {Required field when your sample code resides in another sample repo}
[Optional field] MinTTKversion: {Teams Toolkit version requirement to run the sample - minimum version}
[Optional field] MaxTTKVersion: {Teams Toolkit version requirement to run the sample - maximum version}

@tecton tecton merged commit a31531e into dev Sep 14, 2023
5 checks passed
@tecton tecton deleted the nintan/onboarding-template branch September 14, 2023 01:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants