Skip to content

Commit

Permalink
[Content design system] Add info about requests to document third-par…
Browse files Browse the repository at this point in the history
…ty tools (#45857)

Co-authored-by: Kevin Heis <[email protected]>
  • Loading branch information
ethanpalm and heiskr authored Nov 13, 2023
1 parent 31dea98 commit 9bbc88c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ A [pull request](/github/collaborating-with-issues-and-pull-requests/about-pull-

We cannot accept contributions to the [REST API reference documentation](/rest/reference). If you spot an inaccuracy in the REST API reference documentation, open an issue in the [`rest-api-description`](https://github.com/github/rest-api-description/issues/new?template=schema-inaccuracy.md) repository.

We only document {% data variables.product.prodname_dotcom %} products, features, tools, and extensions. We do not document third-party tools or integrations unless they were codeveloped with {% data variables.product.company_short %}.

### Reviewing your own pull requests

You should always review your own pull request first, before marking it as ready for review by others.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Only include a maximum of eight different tools in an article. Including more to

## Adding new tools

{% data variables.product.prodname_docs %} documents and maintains tool tags for {% data variables.product.prodname_dotcom %} products, {% data variables.product.prodname_dotcom %}-developed tools, and select third-party extensions.
{% data variables.product.prodname_docs %} documents and maintains tool tags for {% data variables.product.prodname_dotcom %} products, {% data variables.product.prodname_dotcom %}-developed tools, and select third-party extensions developed in collaboration with {% data variables.product.company_short %} .

New tools are only added when they are the only way to accurately document something for a specific user need. If a writer determines that adding a new tool is the only way to accurately document something, they need to propose the new tool in a content design plan. Whoever reviews the content design plan should consider any alternative ways to address the documentation needs without adding a new tool. If a new tool is the only way to create accurate documentation, the new tool should be added. If there is an alternative content solution that does not add a new tool, that option should be used.

Expand Down

0 comments on commit 9bbc88c

Please sign in to comment.