7c642a4766
* Add issue template for partner-owned documentation * Add partner name and URL requirement * Fix typo * Place emphasis on automation not possession * Soften compliance requirement * Clarify that applications must be accepted * Fix typo * Clarify that the tasks are the partner's responsibility to complete * Use lower case representation of Pull Request Co-authored-by: Emily Gould <4822039+emilyistoofunky@users.noreply.github.com> * Tweak intent of issue template Co-authored-by: Emily Gould <4822039+emilyistoofunky@users.noreply.github.com> * Merge supporting material under PR section * Add bandwidth expectations * Add templates for partner guides * Fix typo: s/production/product * Add link to general contributing guidelines * Include teams to be mentioned for awareness * Add further documentation requirements * Update contributing/github-partners/README.md Co-authored-by: Emily Gould <4822039+emilyistoofunky@users.noreply.github.com> * Add tutorial template for partners * Provide only one template -- the Tutorial template * Document use of contributor YAML frontmatter * Remove internal repo references * Resolve tests/meta failures Co-authored-by: Emily Gould <4822039+emilyistoofunky@users.noreply.github.com> Co-authored-by: Leona B. Campbell <3880403+runleonarun@users.noreply.github.com>
57 lines
2.1 KiB
Markdown
57 lines
2.1 KiB
Markdown
---
|
|
title: Tutorial title
|
|
intro: 'Article intro. See tips for a great intro below'
|
|
product: '{{ optional product callout }}'
|
|
productVersions:
|
|
contributor:
|
|
name:
|
|
URL:
|
|
---
|
|
|
|
<!-- Remember to add the tutorial title, intro, product version, contributor name, and contributor URL above -->
|
|
<!-- Great intros clarify who the tutorial is intended for, state what the user will accomplish, state the technology(ies) that will be used.-->
|
|
|
|
### Introduction
|
|
|
|
<!-- The tutorial introduction should include the following in a short paragraph:
|
|
|
|
- Clarify audience
|
|
- State prerequisites and prior knowledge needed
|
|
- State what the user will accomplish or build and the user problem it solves
|
|
- Link to an example of the project the user will complete -->
|
|
|
|
### Step 1: Action the user will take
|
|
|
|
<!-- In one sentence, describe what the user will do in this step -->
|
|
<!-- Steps should break down the tasks the user will complete in sequential order -->
|
|
<!-- Avoid replicating conceptual information that is covered elsewhere, provide inline links instead. Only include conceptual information unique to this use case. -->
|
|
|
|
#### Task chunk
|
|
|
|
<!-- A step may require the user to perform several tasks - break those tasks down into chunks, allowing the user to scan quickly to find their place if they navigated away from this screen to perform the task. -->
|
|
<!-- An example might be creating a PAT for the action to use and then storing it in secrets -->
|
|
<!-- For UI based tasks, include the button or options the users should click -->
|
|
<!-- If the task adds code, include the code in context (don't just show `needs: setup` show the entire `setup` and `dependent` jobs) -->
|
|
|
|
#### Another task chunk
|
|
|
|
<!-- remove all of these comments when you're done -->
|
|
|
|
### Step 2: Do the next thing
|
|
|
|
<!-- Rinse and repeat, adding steps and tasks until the tutorial is complete
|
|
|
|
<!-- remember to show code snippets in context -->
|
|
|
|
```yaml
|
|
on:
|
|
schedule:
|
|
- cron: "40 19 * * *"
|
|
```
|
|
|
|
### Further reading
|
|
|
|
<!-- include a bulleted list of tutorials or articles the user can reference to extend the concepts taught in this tutorial -->
|
|
|
|
- "[Article title](article-URL)"
|