Skip to content

Commit

Permalink
Add guidance for documenting third-party products (#897)
Browse files Browse the repository at this point in the history
  • Loading branch information
imatwawana authored Nov 13, 2024
1 parent 187b82e commit d6a7ec0
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/sources/write/style-guide/style-conventions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,16 @@ Avoid mentioning other companies in technical documentation. Competitive content

There are some situations where you must mention another company, such as in data source plugin documentation or a migration guide. Otherwise, avoid doing so.

### Don't document third-party products

<!-- vale Grafana.We = NO -->

When documenting how our products integrate with partner products, document our usage of them, but don't document the product itself.

Whenever possible, structure documentation so that you can link to the appropriate location in the third-party documentation.

<!-- vale Grafana.We = YES -->

## Address users clearly

<!-- vale Grafana.We = NO -->
Expand Down

0 comments on commit d6a7ec0

Please sign in to comment.