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>
2.5 KiB
2.5 KiB
name, about, title, labels, assignees
| name | about | title | labels | assignees | |
|---|---|---|---|---|---|
| Partner-owned product documentation | Initiate a set of tasks to be completed by a GitHub partner wishing to document how their product works with GitHub |
|
Pre-requisites
- Prior to submitting documentation, please apply to join the GitHub Technology Partner Program: partner.github.com/apply. Please feel free to proceed once your application is approved.
Tasks
Please be sure to complete each of the following:
Third-party product documentation:
- MUST follow our general contributing guidelines for voice and markup format.
- MUST emphasize how the third-party product works with GitHub.
- MUST be written in Markdown format, using one of the templates provided
- MUST include the name and URL of the GitHub technology partner responsible for maintenance of the documentation being contributed. This should be added via the
contributor.nameandcontributor.URLproperties in the template's YAML frontmatter. - MUST be proposed via a pull request to this repo following the GitHub Flow.
- MUST be located in the root of the
contentfolder. Your filename MUST match the GitHub technology partner name, and use the.mdfile extension.
The Pull Request:
- MUST reference this issue, e.g. via
closes #<this issue number> - MUST pass the automated CI checks
- MUST include links to supporting material demonstrating the functionality being documented (this can be a link to a public GitHub repo, or a video / screencast walkthrough)
Once all tasks are completed, please mention @github/docs-content for next steps.
/cc @github/partner-engineering for 👀