Skip to content

Commit

Permalink
Docs: adds deprecation guidelines to toolkit (#413)
Browse files Browse the repository at this point in the history
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Jack Baldry <[email protected]>
  • Loading branch information
3 people authored Jan 15, 2024
1 parent 55e1a9a commit 82f1cf8
Show file tree
Hide file tree
Showing 4 changed files with 117 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/sources/about-grafana-docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Introduction to documentation
menuTitle: Introduction to documentation
menuTitle: Introduction
description: Learn about Grafana's documentation
weight: 100
aliases:
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/contribute-documentation/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Contribute to documentation
menuTitle: Contribute to documentation
menuTitle: Contribute
description: This section describes the different ways of contributing to documentation.
weight: 200
aliases:
Expand Down
114 changes: 114 additions & 0 deletions docs/sources/write/deprecate-remove/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
---
title: Deprecate or remove content
menuTitle: Deprecate or remove
description: Learn about deprecating or removing content in your documentation.
weight: 900
aliases:
- /docs/writers-toolkit/write/deprecate-remove
Keywords:
- deprecate
- remove
---

# Deprecate or remove content

<!-- vale Google.Passive = NO -->

**Deprecation** occurs when a feature or product is planned for removal in a future release.
In the period between deprecation and removal, it's in maintenance.

**Removal** is when the product or feature is removed and no longer supported.

The process for handling these scenarios varies according to how the product or feature is being phased out or maintained.

<!-- vale Google.Passive = YES -->

You should notify users two minor releases in advance of any planned removal of a feature.
For example, if you plan to remove a feature in Grafana v9.5, then you should begin communicating that information to users in Grafana v9.3.

To ensure that users are fully aware of the stages of deprecation for their products or features, you should:

- Inform customers of deprecation using notes in the product's What’s New, documentation, and where necessary, in the UI.
- Inform the field by emailing [`[email protected]`](mailto:[email protected]) or by reaching out on Slack in the `#field-engineering-with-nomads` channel
- Update these notes once removal has taken place.
- Announce the deprecation in the Grafana [community slack](https://grafana.slack.com/archives/C05675Y4F) and [forum](https://community.grafana.com/).
- Inform CX and Solution Engineering.

## Deprecation

Scenario: "You're planning on removing the feature or product in a future release."

Example text:

```
{{% admonition type="caution" %}}
Starting with <RELEASE>, <PRODUCT OR FEATURE NAME> is deprecated.
It will be removed in a future release.
{{% /admonition %}}
```

If you know the release, enter the release instead of "future".

### Removal

Scenario: "You've removed a feature."

Example text:

```
{{% admonition type="warning" %}}
<PRODUCT OR FEATURE NAME> is removed.
It is no longer deployed, enhanced, or supported.
{{% /admonition %}}
```

## Documentation deprecation

Scenario: There are situations in which you may deprecate documentation along with and/or independent of feature deprecation.

Example text:

```
{{% admonition type="caution" %}}
Starting with release <VERSION>`, the <TOPIC TITLE> documentation will no longer be published because <RATIONALE>.
Link to documentation, if it exists.
{{% /admonition %}}
```

<!-- vale Google.Will = NO -->
<!-- vale Google.Passive = NO -->

Example: "As of Grafana 9.2, release notes will no longer be published, because they duplicate the content available in the What’s New document and the CHANGELOG."

<!-- vale Google.Passive = YES -->
<!-- vale Google.Will = YES -->

## How to address deprecation

The following process describes how to address deprecation.
This process applies when you deprecate a feature and associated documentation is also deprecated and also when you deprecate documentation independently of feature deprecation.

You may need to add the preceding notes to both the documentation _and_ the UI.

1. Writers, Engineers, or Product Managers determine documentation impacted by deprecation.
<!-- vale Grafana.Spelling = NO -->

If you have a writer assigned to your team, work with your writer.
If you don't have an assigned writer, contact [Fiona Peers Artiaga](mailto:[email protected]).

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

1. If you don't have a writer assigned to your team, Engineers or Product Managers communicate with the Docs Squad and provide links to the impacted documentation, the rationale for the deprecation, and timing.
Post your message in the [#docs](https://raintank-corp.slack.com/archives/C5PG2JK8W) channel.

The Docs Team triage process makes a writer aware of any pending documentation deprecation.

1. In the PR that deprecates the documentation, writers, engineers, or Product Managers provide the rationale for deprecating the documentation in the comments using the documentation deprecation language identified in the preceding table, and if there is alternative documentation that a user can refer to, provide a link.

GitHub automatically assigns the writer associated with those documentation as a reviewer of the PR.

<!-- vale Google.Parens = NO -->

1. The writer either drafts the PR or reviews and approves the PR and adds a notice of the deprecation (including links, if available) in the draft What’s New document.

<!-- vale Google.Parens = YES -->
2 changes: 1 addition & 1 deletion docs/sources/write/reuse-content/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Reuse content
menuTitle: Reuse content
menuTitle: Reuse
description: Learn about reusing content in your documentation.
weight: 800
aliases:
Expand Down

0 comments on commit 82f1cf8

Please sign in to comment.