1
0
mirror of synced 2025-12-26 14:02:45 -05:00
Files
docs/contributing/github-partners
Steve Winton 7c642a4766 Add issue template to guide partner documentation contributions (#17998)
* 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>
2021-03-12 11:05:29 -08:00
..

GitHub Partners

This folder contains templates to be used by GitHub's technology partners when contributing documentation, such as guides.

To get started, please open an issue using this link.

Templates

Tutorial template

Tutorials guide the reader through an entire workflow to complete a task.

You should consider creating a tutorial when:

  • The user has a basic understanding of the product and is interested in extending their use and understanding to solve a specific problem.
  • The user is looking for expert advice and a detailed discussion on best practices related their problem.
  • The user may have implemented a similar solution in the past using a different product.
  • The user wants to validate whether the solution is appropriate for their needs.

Get started with this template here.