From ed8725863db9710cb0eae6be9f6a7bf0c054e886 Mon Sep 17 00:00:00 2001 From: Eve Meelan <81647476+Eve832@users.noreply.github.com> Date: Fri, 17 Nov 2023 12:34:58 -0800 Subject: [PATCH 01/24] first pass at What's new update. Not sure about the content I commented out. --- .../contribute-release-notes/index.md | 64 +++++++++++++++---- 1 file changed, 51 insertions(+), 13 deletions(-) diff --git a/docs/sources/contribute-documentation/contribute-release-notes/index.md b/docs/sources/contribute-documentation/contribute-release-notes/index.md index b941d0ea3..5c1761422 100644 --- a/docs/sources/contribute-documentation/contribute-release-notes/index.md +++ b/docs/sources/contribute-documentation/contribute-release-notes/index.md @@ -14,19 +14,56 @@ keywords: This topic explains the decisions and actions associated with collecting, writing, and publishing What's new content. -> **Note:** This topic is only relevant for internal Grafana Labs contributors. +{{% admonition type="note" %}} +This topic is only relevant for internal Grafana Labs contributors. +{{% /admonition %}} ## What's new doc development process -Developing directly in Markdown reduces errors and removes a manual (toilsome and error-prone) step, by creating, editing, discussing, and publishing in the same format from which we will publish in GitHub, using the Grafana repository. - -Consider adding an image, though be aware that we will not maintain them, as the document reflects a "point in time." If you need to add an image, refer to [Image, diagram, and screenshot guidelines]({{< relref "../../write/image-guidelines" >}}). - -### When the prior release is complete +What’s new content is published to our site through the website content management system (CMS), and can be accessed here: [](). + +Because this platform is meant to be used by the entire organization, by default anyone can contribute and publish to What’s new, without the need for approval. **Quality assurance will need to be a conversation within and between contributing teams and internal stakeholders**, but there are some best practice guidelines described in the last two sections of this topic. + +Release notes should be entered into the CMS 2-4 weeks before the feature is available, depending on the size of the product or feature. This gives the GTM team time for promotion and enablement. For Grafana versioned releases, have your content entered in the CMS by the cut off date communicated by the delivery team. For more information, see the RADS guidelines. + +When you’re ready to add a What’s new entry, complete the following steps: +1. Fill out the fields: + * FEATURE NAME - Short headline for the improvement. For example, “Grafana OnCall integration for Alerting.” + * DATE - Date and time (UTC) that you want this note published. If you’ve opened a review PR, it will need to be merged before the date/time. If you enter a date that has passed, the note will publish immediately with that date. + * CONTACT - First and last name. The contents of this field are not publicly viewable. + * TAGS (OPTIONAL) - Select category tags that users can use to filter their view. Select as many as apply. + * CLOUD AVAILABILITY - Select the stage of the feature’s cloud release. + * CLOUD OFFERING - Select which account types have access to the feature. + * SELF-MANAGED EDITIONS - Select the on-premises offering(s) where this feature is available. + * BODY - Include an overview of the feature and the problem it solves. If you want to view some best practices around what to write here, see Writing guidelines for what’s new below. + Add any images and a link to your public Youtube video here. + If you need more information on adding an image, refer to: Image, diagram, and screenshot guidelines. + * FEATURE TOGGLE NAME (OPTIONAL) - Exact name of the feature toggle for this feature, if one exists. For example, publicDashboards. + * DOCUMENTATION URL (OPTIONAL) - URL to the public documentation for this feature. + * GRAFANA URL PATH (OPTIONAL) - URL path to the feature in a Grafana Cloud stack. For example, /alerting/notifications. + * INTERNAL INFORMATION (OPTIONAL) - Information for Grafana Labs employees only. For example, ProductDNA, slack channel, FAQ, training docs or videos. Used for training and internal announcements. + +1. Request a review (optional). + Select this option to open a PR in the website repository for review. +1. Click **Save**. When the note is saved, you can select **In review** from the **Status:** dropdown menu. + The review PR will appear in the website repository. Note that the Documentation Team does not automatically review these requests; teams that create What’s new entries are responsible for determining their own review process. However, there are two weekly Office Hours meetings offered by the Documentation Team that you’re welcome to attend for guidance and assistance: + * Docs squad office hours (early) + * Docs squad office hours (late) + If you open a PR, ensure that it’s merged in time for your feature release date. + +1. Preview your entry and ensure that it looks the way you want it to. + For Grafana versioned releases, the content will be collected by [someone] and published in the versioned What’s new at a later date. + + + + + + + -## How to determine if content belongs in a What's new document +## How to determine if content belongs in What's new Grafana publishes a What's new [docs page](/docs/grafana/latest/whatsnew/) and [blog post](/blog/2022/11/29/grafana-9.3-release/) along with every minor and major release. + These posts are popular, and a good way for users to learn about the exciting new things we've released. What's new also drives our go-to-market enablement: we train the field and make videos on the topics in What's new. From fb6200bd15e0ccfe56a2821f42691b027ab942fd Mon Sep 17 00:00:00 2001 From: Eve Meelan <81647476+Eve832@users.noreply.github.com> Date: Fri, 17 Nov 2023 12:43:28 -0800 Subject: [PATCH 02/24] Update docs/sources/contribute-documentation/contribute-release-notes/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- .../contribute-documentation/contribute-release-notes/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/sources/contribute-documentation/contribute-release-notes/index.md b/docs/sources/contribute-documentation/contribute-release-notes/index.md index 5c1761422..f47d48800 100644 --- a/docs/sources/contribute-documentation/contribute-release-notes/index.md +++ b/docs/sources/contribute-documentation/contribute-release-notes/index.md @@ -27,6 +27,7 @@ Because this platform is meant to be used by the entire organization, by default Release notes should be entered into the CMS 2-4 weeks before the feature is available, depending on the size of the product or feature. This gives the GTM team time for promotion and enablement. For Grafana versioned releases, have your content entered in the CMS by the cut off date communicated by the delivery team. For more information, see the RADS guidelines. When you’re ready to add a What’s new entry, complete the following steps: + 1. Fill out the fields: * FEATURE NAME - Short headline for the improvement. For example, “Grafana OnCall integration for Alerting.” * DATE - Date and time (UTC) that you want this note published. If you’ve opened a review PR, it will need to be merged before the date/time. If you enter a date that has passed, the note will publish immediately with that date. From 7f169b3ae57c366fd7360339b537cab654aea2f9 Mon Sep 17 00:00:00 2001 From: Eve Meelan <81647476+Eve832@users.noreply.github.com> Date: Fri, 17 Nov 2023 12:43:59 -0800 Subject: [PATCH 03/24] linter --- .../contribute-release-notes/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sources/contribute-documentation/contribute-release-notes/index.md b/docs/sources/contribute-documentation/contribute-release-notes/index.md index f47d48800..91d46cc27 100644 --- a/docs/sources/contribute-documentation/contribute-release-notes/index.md +++ b/docs/sources/contribute-documentation/contribute-release-notes/index.md @@ -35,9 +35,9 @@ When you’re ready to add a What’s new entry, complete the following steps: * TAGS (OPTIONAL) - Select category tags that users can use to filter their view. Select as many as apply. * CLOUD AVAILABILITY - Select the stage of the feature’s cloud release. * CLOUD OFFERING - Select which account types have access to the feature. - * SELF-MANAGED EDITIONS - Select the on-premises offering(s) where this feature is available. + * SELF-MANAGED EDITIONS - Select the on-premises offerings where this feature is available. * BODY - Include an overview of the feature and the problem it solves. If you want to view some best practices around what to write here, see Writing guidelines for what’s new below. - Add any images and a link to your public Youtube video here. + Add any images and a link to your public YouTube video here. If you need more information on adding an image, refer to: Image, diagram, and screenshot guidelines. * FEATURE TOGGLE NAME (OPTIONAL) - Exact name of the feature toggle for this feature, if one exists. For example, publicDashboards. * DOCUMENTATION URL (OPTIONAL) - URL to the public documentation for this feature. From 8f10bdde4e4d685a0a1e72dd73571352f32ca732 Mon Sep 17 00:00:00 2001 From: Eve Meelan <81647476+Eve832@users.noreply.github.com> Date: Fri, 17 Nov 2023 12:46:29 -0800 Subject: [PATCH 04/24] Update docs/sources/contribute-documentation/contribute-release-notes/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- .../contribute-release-notes/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/sources/contribute-documentation/contribute-release-notes/index.md b/docs/sources/contribute-documentation/contribute-release-notes/index.md index 91d46cc27..80bf16173 100644 --- a/docs/sources/contribute-documentation/contribute-release-notes/index.md +++ b/docs/sources/contribute-documentation/contribute-release-notes/index.md @@ -39,10 +39,10 @@ When you’re ready to add a What’s new entry, complete the following steps: * BODY - Include an overview of the feature and the problem it solves. If you want to view some best practices around what to write here, see Writing guidelines for what’s new below. Add any images and a link to your public YouTube video here. If you need more information on adding an image, refer to: Image, diagram, and screenshot guidelines. - * FEATURE TOGGLE NAME (OPTIONAL) - Exact name of the feature toggle for this feature, if one exists. For example, publicDashboards. - * DOCUMENTATION URL (OPTIONAL) - URL to the public documentation for this feature. - * GRAFANA URL PATH (OPTIONAL) - URL path to the feature in a Grafana Cloud stack. For example, /alerting/notifications. - * INTERNAL INFORMATION (OPTIONAL) - Information for Grafana Labs employees only. For example, ProductDNA, slack channel, FAQ, training docs or videos. Used for training and internal announcements. +- FEATURE TOGGLE NAME (OPTIONAL) - Exact name of the feature toggle for this feature, if one exists. For example, publicDashboards. +- DOCUMENTATION URL (OPTIONAL) - URL to the public documentation for this feature. +- GRAFANA URL PATH (OPTIONAL) - URL path to the feature in a Grafana Cloud stack. For example, /alerting/notifications. +- INTERNAL INFORMATION (OPTIONAL) - Information for Grafana Labs employees only. For example, ProductDNA, slack channel, FAQ, training docs or videos. Used for training and internal announcements. 1. Request a review (optional). Select this option to open a PR in the website repository for review. From 48432a8dbc36042e84837335e5ac70cc7e42dc86 Mon Sep 17 00:00:00 2001 From: Eve Meelan <81647476+Eve832@users.noreply.github.com> Date: Fri, 17 Nov 2023 12:46:49 -0800 Subject: [PATCH 05/24] Update docs/sources/contribute-documentation/contribute-release-notes/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- .../contribute-release-notes/index.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/sources/contribute-documentation/contribute-release-notes/index.md b/docs/sources/contribute-documentation/contribute-release-notes/index.md index 80bf16173..22c9b2c99 100644 --- a/docs/sources/contribute-documentation/contribute-release-notes/index.md +++ b/docs/sources/contribute-documentation/contribute-release-notes/index.md @@ -47,10 +47,11 @@ When you’re ready to add a What’s new entry, complete the following steps: 1. Request a review (optional). Select this option to open a PR in the website repository for review. 1. Click **Save**. When the note is saved, you can select **In review** from the **Status:** dropdown menu. - The review PR will appear in the website repository. Note that the Documentation Team does not automatically review these requests; teams that create What’s new entries are responsible for determining their own review process. However, there are two weekly Office Hours meetings offered by the Documentation Team that you’re welcome to attend for guidance and assistance: - * Docs squad office hours (early) - * Docs squad office hours (late) - If you open a PR, ensure that it’s merged in time for your feature release date. + The review PR will appear in the website repository. Note that the Documentation Team does not automatically review these requests; teams that create What’s new entries are responsible for determining their own review process. However, there are two weekly Office Hours meetings offered by the Documentation Team that you’re welcome to attend for guidance and assistance: + + - Docs squad office hours (early) + - Docs squad office hours (late) + If you open a PR, ensure that it’s merged in time for your feature release date. 1. Preview your entry and ensure that it looks the way you want it to. For Grafana versioned releases, the content will be collected by [someone] and published in the versioned What’s new at a later date. From a71b3c11eda415c40189b83f7680a9da06829d87 Mon Sep 17 00:00:00 2001 From: Eve Meelan <81647476+Eve832@users.noreply.github.com> Date: Fri, 17 Nov 2023 12:47:23 -0800 Subject: [PATCH 06/24] Update docs/sources/contribute-documentation/contribute-release-notes/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- .../contribute-documentation/contribute-release-notes/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/contribute-documentation/contribute-release-notes/index.md b/docs/sources/contribute-documentation/contribute-release-notes/index.md index 22c9b2c99..379429651 100644 --- a/docs/sources/contribute-documentation/contribute-release-notes/index.md +++ b/docs/sources/contribute-documentation/contribute-release-notes/index.md @@ -100,7 +100,7 @@ Complete the following steps in the days leading up to the release: 1. Five days before the What's new freeze, the technical program manager sends a last call to developer teams to get in their What's new content. 1. The day after the freeze date, a PM reviews all content and adjusts wording, where appropriate. - +Whether your entry is published or not, it's always best to use the CMS to make any changes. - - From 37cfe89e5bf83aed69b79657dc5e37f7e7ef997b Mon Sep 17 00:00:00 2001 From: Isabel <76437239+imatwawana@users.noreply.github.com> Date: Tue, 21 Nov 2023 12:54:26 -0500 Subject: [PATCH 15/24] Fixed title --- .../contribute-documentation/contribute-release-notes/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/contribute-documentation/contribute-release-notes/index.md b/docs/sources/contribute-documentation/contribute-release-notes/index.md index 655673bda..dadbe9cd1 100644 --- a/docs/sources/contribute-documentation/contribute-release-notes/index.md +++ b/docs/sources/contribute-documentation/contribute-release-notes/index.md @@ -76,7 +76,7 @@ Whether your entry is published or not, it's always best to use the CMS to make If your entry is published in both _What's new in Cloud_ and _What's new in Grafana_, or it's after the cut-off date for a versioned release, update the CMS and then reach out to the person who's creating the versioned release notes. -### Creating the versioned release notes +### Create the versioned release notes 1. After the previous version of Grafana is released, the DRI cuts a branch and creates a draft PR with an empty What's new doc to be populated with the What's new content for the next release, along with the updated What's new index page. This PR: From 8cb011225ddd77fe3204c28abab2ce56b202a411 Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Wed, 22 Nov 2023 09:41:52 +0000 Subject: [PATCH 16/24] Prettier Signed-off-by: Jack Baldry --- .../contribute-release-notes/index.md | 66 +++++++++---------- 1 file changed, 33 insertions(+), 33 deletions(-) diff --git a/docs/sources/contribute-documentation/contribute-release-notes/index.md b/docs/sources/contribute-documentation/contribute-release-notes/index.md index dadbe9cd1..7a9fe9023 100644 --- a/docs/sources/contribute-documentation/contribute-release-notes/index.md +++ b/docs/sources/contribute-documentation/contribute-release-notes/index.md @@ -30,43 +30,43 @@ When you’re ready to add a What’s new entry, complete the following steps: 1. Fill out the fields: - - **FEATURE NAME** - Short headline for the improvement. For example, “Grafana OnCall integration for Alerting.” - - **DATE** - Date and time (UTC) that you want this note published. Typically, this is also the feature release date. If you’ve opened a review PR, you must merge it before the date/time you've added here. If you enter a date that has passed, the note will publish immediately with that date. - - **CONTACT** - First and last name. The contents of this field aren't publicly viewable. - - **TAGS (OPTIONAL)** - Select category tags that users can use to filter their view. Select as many as apply. - - **CLOUD AVAILABILITY** - Select the stage of the feature’s Cloud release. - - **CLOUD OFFERING** - Select which account types have access to the feature. - - **SELF-MANAGED AVAILABILITY** - Select the stage of the feature's self-managed release. - - **SELF-MANAGED EDITIONS** - Select the on-premises offerings where this feature is available, or if it's not available in self-managed editions, select "None." - - **BODY** - Include an overview of the feature and the problem it solves. - - If you want to view some best practices around what to write here, see Writing guidelines for what’s new below. - Add any images and a link to your public YouTube video here. - If you need more information on adding an image, refer to [Image, diagram, and screenshot guidelines](https://grafana.com/docs/writers-toolkit/write/image-guidelines/). - - - **FEATURE TOGGLE NAME (OPTIONAL)** - Exact name of the feature toggle for this feature, if one exists. For example, `publicDashboards`. - - **DOCUMENTATION URL (OPTIONAL)** - URL to the public documentation for this feature. - - **GRAFANA URL PATH (OPTIONAL)** - URL path to the feature in a Grafana Cloud stack. For example, `/alerting/notifications`. - - **INTERNAL INFORMATION (OPTIONAL)** - Information for Grafana Labs employees only. For example, ProductDNA, slack channel, FAQ, training docs or videos. Used for training and internal announcements. + - **FEATURE NAME** - Short headline for the improvement. For example, “Grafana OnCall integration for Alerting.” + - **DATE** - Date and time (UTC) that you want this note published. Typically, this is also the feature release date. If you’ve opened a review PR, you must merge it before the date/time you've added here. If you enter a date that has passed, the note will publish immediately with that date. + - **CONTACT** - First and last name. The contents of this field aren't publicly viewable. + - **TAGS (OPTIONAL)** - Select category tags that users can use to filter their view. Select as many as apply. + - **CLOUD AVAILABILITY** - Select the stage of the feature’s Cloud release. + - **CLOUD OFFERING** - Select which account types have access to the feature. + - **SELF-MANAGED AVAILABILITY** - Select the stage of the feature's self-managed release. + - **SELF-MANAGED EDITIONS** - Select the on-premises offerings where this feature is available, or if it's not available in self-managed editions, select "None." + - **BODY** - Include an overview of the feature and the problem it solves. + + If you want to view some best practices around what to write here, see Writing guidelines for what’s new below. + Add any images and a link to your public YouTube video here. + If you need more information on adding an image, refer to [Image, diagram, and screenshot guidelines](https://grafana.com/docs/writers-toolkit/write/image-guidelines/). + + - **FEATURE TOGGLE NAME (OPTIONAL)** - Exact name of the feature toggle for this feature, if one exists. For example, `publicDashboards`. + - **DOCUMENTATION URL (OPTIONAL)** - URL to the public documentation for this feature. + - **GRAFANA URL PATH (OPTIONAL)** - URL path to the feature in a Grafana Cloud stack. For example, `/alerting/notifications`. + - **INTERNAL INFORMATION (OPTIONAL)** - Information for Grafana Labs employees only. For example, ProductDNA, slack channel, FAQ, training docs or videos. Used for training and internal announcements. 1. Click **Save**. The entry is now in **Draft** status. 1. If your entry is ready to publish, proceed to step 4. If your entry requires review, follow these steps: - - 1. In the **Status** drop-down, select **In review.** - - A review PR is generated in the `grafana/website` repository. **The Documentation Team does not automatically review these requests; teams that create What’s new entries are responsible for determining their own review process.** However, there are two weekly Office Hours meetings offered by the Documentation Team that you’re welcome to attend for guidance and assistance: - - [Docs squad office hours (early)](https://calendar.google.com/calendar/event?action=TEMPLATE&tmeid=NmoxZ2w0NHBoazgxaW80cTN0MW82aG1xMmxfMjAyMzExMjJUMDkwMDAwWiBpc2FiZWwubWF0d2F3YW5hQGdyYWZhbmEuY29t&tmsrc=isabel.matwawana%40grafana.com&scp=ALL) - - [Docs squad office hours (late)](https://calendar.google.com/calendar/event?action=TEMPLATE&tmeid=NTI0MWZxYTYwY3FjYW5waWM1OWVjMDBkaWpfMjAyMzExMjJUMjEwMDAwWiBpc2FiZWwubWF0d2F3YW5hQGdyYWZhbmEuY29t&tmsrc=isabel.matwawana%40grafana.com&scp=ALL) + 1. In the **Status** drop-down, select **In review.** - 1. Merge your PR in time for your feature release date. - - Merging your PR ensures your entry is published on the date you entered and it automatically updates the status of your entry in the CMS. + A review PR is generated in the `grafana/website` repository. **The Documentation Team does not automatically review these requests; teams that create What’s new entries are responsible for determining their own review process.** However, there are two weekly Office Hours meetings offered by the Documentation Team that you’re welcome to attend for guidance and assistance: + + - [Docs squad office hours (early)](https://calendar.google.com/calendar/event?action=TEMPLATE&tmeid=NmoxZ2w0NHBoazgxaW80cTN0MW82aG1xMmxfMjAyMzExMjJUMDkwMDAwWiBpc2FiZWwubWF0d2F3YW5hQGdyYWZhbmEuY29t&tmsrc=isabel.matwawana%40grafana.com&scp=ALL) + - [Docs squad office hours (late)](https://calendar.google.com/calendar/event?action=TEMPLATE&tmeid=NTI0MWZxYTYwY3FjYW5waWM1OWVjMDBkaWpfMjAyMzExMjJUMjEwMDAwWiBpc2FiZWwubWF0d2F3YW5hQGdyYWZhbmEuY29t&tmsrc=isabel.matwawana%40grafana.com&scp=ALL) + + 1. Merge your PR in time for your feature release date. + + Merging your PR ensures your entry is published on the date you entered and it automatically updates the status of your entry in the CMS. 1. To publish your entry from the CMS, follow these steps: - - 1. In the **Status** drop-down, click **Ready**. - 1. In the **Publish** drop-down, click **Publish now**. The entry will appear in [What's new in Cloud](https://grafana.com/docs/grafana-cloud/whatsnew/) on the date you entered. + + 1. In the **Status** drop-down, click **Ready**. + 1. In the **Publish** drop-down, click **Publish now**. The entry will appear in [What's new in Cloud](https://grafana.com/docs/grafana-cloud/whatsnew/) on the date you entered. For Grafana versioned releases, the content entered in the CMS will be collected by [someone] and published in the versioned What’s new at a later date. Refer to [Creating the self-managed/versioned release notes](#creating-the-versioned-release-notes) @@ -87,10 +87,10 @@ If your entry is published in both _What's new in Cloud_ and _What's new in Graf 1. After the cut-off date for the self-managed/versioned release, the DRI goes [where] and filters the What's new content in the CMS by the following properties: - - Self-managed editions - - Date range (from the previous release to the current date) +- Self-managed editions +- Date range (from the previous release to the current date) -1. The DRI adds this content to the What's new doc using the tags data to group items appropriately. +1. The DRI adds this content to the What's new doc using the tags data to group items appropriately. 1. PM reviews the content to adjust order, **but not copy**. All copy editing must take place when entries are added in the CMS. From 24a330139ab6b3e354b2ac3d00df7b4423397c08 Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Wed, 22 Nov 2023 09:55:03 +0000 Subject: [PATCH 17/24] Fix linting Signed-off-by: Jack Baldry --- .../contribute-release-notes/index.md | 35 +++++++++++-------- vale/Grafana/Headings.yml | 1 + 2 files changed, 21 insertions(+), 15 deletions(-) diff --git a/docs/sources/contribute-documentation/contribute-release-notes/index.md b/docs/sources/contribute-documentation/contribute-release-notes/index.md index 7a9fe9023..eb93a0888 100644 --- a/docs/sources/contribute-documentation/contribute-release-notes/index.md +++ b/docs/sources/contribute-documentation/contribute-release-notes/index.md @@ -20,7 +20,7 @@ This topic is only relevant for internal Grafana Labs contributors. ## What's new doc development process -What’s new content is published to our site through the website content management system (CMS), and can be accessed [here](). (link to CMS form) +What’s new content is published to the website through the website content management system (CMS), and can be accessed [here](https://admin.grafana.com/content-admin/#/collections/whatsnew). Because this platform is meant to be used by the entire organization, by default anyone can contribute and publish to What’s new, without the need for approval. **Quality assurance is a conversation within and between contributing teams and internal stakeholders**, but there are some best practice guidelines described in the last two sections of this topic. @@ -31,7 +31,7 @@ When you’re ready to add a What’s new entry, complete the following steps: 1. Fill out the fields: - **FEATURE NAME** - Short headline for the improvement. For example, “Grafana OnCall integration for Alerting.” - - **DATE** - Date and time (UTC) that you want this note published. Typically, this is also the feature release date. If you’ve opened a review PR, you must merge it before the date/time you've added here. If you enter a date that has passed, the note will publish immediately with that date. + - **DATE** - Date and time (UTC) that you want this note published. Typically, this is also the feature release date. If you’ve opened a review PR, you must merge it before the date/time you've added here. If you enter a date that has passed, the note is published immediately on that date. - **CONTACT** - First and last name. The contents of this field aren't publicly viewable. - **TAGS (OPTIONAL)** - Select category tags that users can use to filter their view. Select as many as apply. - **CLOUD AVAILABILITY** - Select the stage of the feature’s Cloud release. @@ -66,9 +66,9 @@ When you’re ready to add a What’s new entry, complete the following steps: 1. To publish your entry from the CMS, follow these steps: 1. In the **Status** drop-down, click **Ready**. - 1. In the **Publish** drop-down, click **Publish now**. The entry will appear in [What's new in Cloud](https://grafana.com/docs/grafana-cloud/whatsnew/) on the date you entered. + 1. In the **Publish** drop-down, click **Publish now**. The entry appears in [What's new in Cloud](https://grafana.com/docs/grafana-cloud/whatsnew/) on the date you entered. -For Grafana versioned releases, the content entered in the CMS will be collected by [someone] and published in the versioned What’s new at a later date. Refer to [Creating the self-managed/versioned release notes](#creating-the-versioned-release-notes) +For Grafana versioned releases, the content entered in the CMS is published in the versioned What’s new at a later date. Refer to [Creating the self-managed/ppversioned release notes](#creating-the-versioned-release-notes) ### Edit What's new entries @@ -104,18 +104,23 @@ If your entry is published in both _What's new in Cloud_ and _What's new in Graf 1. On release day, the DRI and merges the What's new branch into `main`. If `main` is no longer the same release as the upcoming release, the DRI should add the appropriate backport label to the PR. + + + The What's new is published in the "next" docs. -When the release branch is promoted to GA, the What's new will also be part of the "latest" doc set.--> +When the release branch is promoted to GA, the What's new will also be part of the "latest" doc set. + + ## How to determine if content belongs in What's new Grafana publishes a What's new [docs page](/docs/grafana/latest/whatsnew/) and [blog post](/blog/2022/11/29/grafana-9.3-release/) along with every minor and major release. -These posts are popular, and a good way for users to learn about the exciting new things we've released. -What's new also drives our go-to-market enablement: we train the field and make videos on the topics in What's new. +These posts are popular, and a good way for users to learn about the exciting new things Grafana has released. +What's new also drives Grafana's go-to-market enablement: it is used to train the field and make videos on the topics in What's new. -However, unlike our comprehensive changelog, What's new is curated. -If it contained every update, it would be too noisy for people to read, and if we wrote a detailed What's new post for every little bug fix, we'd be wasting our time. +However, unlike a comprehensive changelog, What's new is curated. +If it contained every update and a detailed What's new post for every little bug fix, it would be too noisy for people to read. So how do you decide whether to write a What's new post for your latest improvement? @@ -127,8 +132,8 @@ What's new content should address changes that have some kind of material impact - Most visualization changes and most additions to the UI should be in the What's new document, even when they seem small. - Almost every change or addition associated with Prometheus and Loki is of interest, too. - What's new content should also include changes that require customers to do something, like change their API keys to Service Accounts, or stop using a deprecated API or plugin. -- A What's new doc should include announcements—things we want customers to notice and try out. - These could also be notable community contributions where we want to thank a contributor. +- A What's new doc should include announcements—things for customers to notice and try out. + These could also be notable community contributions to thank a contributor. When in doubt, ask your nearest PM or EM. Err on the side of _yes, put it in What's new_. @@ -138,9 +143,9 @@ When in doubt, ask your nearest PM or EM. Err on the side of _yes, put it in Wha - This is one of many transformations, but it is brand-new functionality that a user might not notice if they didn't read the What's new document. What's new is also a low-effort place to describe some nice use cases and examples for the feature so that users adopt it. - The new [Candlestick visualization](/docs/grafana/latest/whatsnew/whats-new-in-v8-3/#candlestick-panel-beta). - - This was a beta feature, but still listed in What's new in order to get the word out and encourage users to try it. + - This was a beta feature, but still listed in What's new to get the word out and encourage users to try it. - All-new Swagger docs for the API. - - This is significant because it makes our documentation much easier to use, and it's a new place for users to go for help when using our API. + - This is significant because it makes Grafana documentation much easier to use, and it's a new place for users to go for help when using the API. - [Removing beta labels from several panels](https://github.com/grafana/grafana/pull/58557), which makes then generally available. - This is a small change code-wise, but a big statement with big customer impact. Customers now know that those plugins are fully supported and recommended for use in production. @@ -149,7 +154,7 @@ When in doubt, ask your nearest PM or EM. Err on the side of _yes, put it in Wha - [Search improvement for Flame graphs](https://github.com/grafana/grafana/pull/61748) - Fuzzy search. Has to be in the blog post. - [Changes to the Prometheus query editor](https://github.com/grafana/grafana/pull/60718) - - These are query patterns for the data source that most of our users use. + - These are query patterns for the data source that most users use. ### Examples of what _not_ to include in What's new @@ -161,7 +166,7 @@ These are important improvements, but are better placed in the changelog than Wh - This is a bug fix that doesn't require customer action. - [A usability improvement to an existing transformation](https://github.com/grafana/grafana/pull/59074) - Nice fix, but very detailed. Should be in the changelog but not What's new. -- [Change regex to accommodate a new branching strategy in Enterprise](https://github.com/grafana/grafana/pull/59429) +- [Change regular expression to accommodate a new branching strategy in Enterprise](https://github.com/grafana/grafana/pull/59429) - This change is invisible to customers. ## Writing guidelines for What's new content diff --git a/vale/Grafana/Headings.yml b/vale/Grafana/Headings.yml index c9038166a..bcb61dfc7 100644 --- a/vale/Grafana/Headings.yml +++ b/vale/Grafana/Headings.yml @@ -30,3 +30,4 @@ exceptions: - Redis - Tempo - TraceQL + - What's new From 3a77a8707e4b1ba837bde1ed1c2ece25ed15f6da Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Wed, 22 Nov 2023 09:56:59 +0000 Subject: [PATCH 18/24] Fix anchor Signed-off-by: Jack Baldry --- .../contribute-documentation/contribute-release-notes/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/contribute-documentation/contribute-release-notes/index.md b/docs/sources/contribute-documentation/contribute-release-notes/index.md index eb93a0888..002a0e945 100644 --- a/docs/sources/contribute-documentation/contribute-release-notes/index.md +++ b/docs/sources/contribute-documentation/contribute-release-notes/index.md @@ -68,7 +68,7 @@ When you’re ready to add a What’s new entry, complete the following steps: 1. In the **Status** drop-down, click **Ready**. 1. In the **Publish** drop-down, click **Publish now**. The entry appears in [What's new in Cloud](https://grafana.com/docs/grafana-cloud/whatsnew/) on the date you entered. -For Grafana versioned releases, the content entered in the CMS is published in the versioned What’s new at a later date. Refer to [Creating the self-managed/ppversioned release notes](#creating-the-versioned-release-notes) +For Grafana versioned releases, the content entered in the CMS is published in the versioned What’s new at a later date. Refer to [Creating the self-managed/ppversioned release notes](#create-the-versioned-release-notes) ### Edit What's new entries From 0b88c1281226ad725f782766fcb3feb9b38e1f10 Mon Sep 17 00:00:00 2001 From: Isabel Matwawana Date: Thu, 23 Nov 2023 11:28:41 -0500 Subject: [PATCH 19/24] Added edit steps and terminology section; made other copy edits --- .../contribute-release-notes/index.md | 49 ++++++++++++------- 1 file changed, 32 insertions(+), 17 deletions(-) diff --git a/docs/sources/contribute-documentation/contribute-release-notes/index.md b/docs/sources/contribute-documentation/contribute-release-notes/index.md index 002a0e945..eaf361923 100644 --- a/docs/sources/contribute-documentation/contribute-release-notes/index.md +++ b/docs/sources/contribute-documentation/contribute-release-notes/index.md @@ -26,18 +26,28 @@ Because this platform is meant to be used by the entire organization, by default Release notes should be entered into the CMS 2-4 weeks before the feature is available, depending on the size of the product or feature. This gives the GTM team time for promotion and enablement. For Grafana versioned releases, have your content entered in the CMS by the cut-off date communicated by the delivery team. For more information, see the [RADS guidelines](https://grafana-intranet--simpplr.vf.force.com/apex/simpplr__app?u=/site/a145f000001dCXBAA2/page/a125f000004oOF7AAM). +Note that in the context of the CMS, the word "published" has a slightly different meaning than in general use: + + - **Published** - Your entry is complete and in **Published** status. It's either visible on the external _What's new in Cloud_ page or is going to automatically become visible on the release date. + - **Live** - Your entry is visible on the _What's new in Cloud_ page. + +### Create a What's new entry + When you’re ready to add a What’s new entry, complete the following steps: 1. Fill out the fields: - **FEATURE NAME** - Short headline for the improvement. For example, “Grafana OnCall integration for Alerting.” - - **DATE** - Date and time (UTC) that you want this note published. Typically, this is also the feature release date. If you’ve opened a review PR, you must merge it before the date/time you've added here. If you enter a date that has passed, the note is published immediately on that date. + - **DATE** - Date and time (UTC) that you want this note to be live. This should also be the feature release date. + + If you’ve opened a review PR, you must merge it before the date/time you've added here. If you enter a date that has passed, the note is published immediately with that date. + - **CONTACT** - First and last name. The contents of this field aren't publicly viewable. - **TAGS (OPTIONAL)** - Select category tags that users can use to filter their view. Select as many as apply. - - **CLOUD AVAILABILITY** - Select the stage of the feature’s Cloud release. - - **CLOUD OFFERING** - Select which account types have access to the feature. - - **SELF-MANAGED AVAILABILITY** - Select the stage of the feature's self-managed release. - - **SELF-MANAGED EDITIONS** - Select the on-premises offerings where this feature is available, or if it's not available in self-managed editions, select "None." + - **CLOUD AVAILABILITY** - Select the stage of the feature’s Cloud release. If the feature isn't available in Cloud, select "None." + - **CLOUD OFFERING** - Select which account types have access to the feature. If the feature isn't available in Cloud, select "None." + - **SELF-MANAGED AVAILABILITY** - Select the stage of the feature's self-managed release. If the feature isn't available in self-managed Grafana, select "None." + - **SELF-MANAGED EDITIONS** - Select the on-premises offerings where this feature is available. If the feature isn't available in self-managed Grafana, select "None." - **BODY** - Include an overview of the feature and the problem it solves. If you want to view some best practices around what to write here, see Writing guidelines for what’s new below. @@ -61,34 +71,39 @@ When you’re ready to add a What’s new entry, complete the following steps: 1. Merge your PR in time for your feature release date. - Merging your PR ensures your entry is published on the date you entered and it automatically updates the status of your entry in the CMS. + Merging your PR ensures your entry is live on the date you entered and it automatically updates the status of your entry in the CMS. 1. To publish your entry from the CMS, follow these steps: 1. In the **Status** drop-down, click **Ready**. 1. In the **Publish** drop-down, click **Publish now**. The entry appears in [What's new in Cloud](https://grafana.com/docs/grafana-cloud/whatsnew/) on the date you entered. -For Grafana versioned releases, the content entered in the CMS is published in the versioned What’s new at a later date. Refer to [Creating the self-managed/ppversioned release notes](#create-the-versioned-release-notes) +For Grafana versioned releases, the content entered in the CMS is published in the versioned What’s new at a later date. Refer to [Creating the versioned release notes](#create-the-versioned-release-notes) ### Edit What's new entries -Whether your entry is published or not, it's always best to use the CMS to make any changes. +Regardless of the status of your entry, it's always best to use the CMS to make any changes. To make edits, follow these steps: -If your entry is published in both _What's new in Cloud_ and _What's new in Grafana_, or it's after the cut-off date for a versioned release, update the CMS and then reach out to the person who's creating the versioned release notes. +1. Navigate to the [CMS](https://admin.grafana.com/content-admin/#/collections/whatsnew). +1. Update the fields that you need to change. +1. Click **Save**. The entry is now in **Draft** status. +1. Do one of the following: + + - If your entry is ready to publish, select **Ready** in the **Status** drop-down, and then **Publish now** in the **Publish** drop-down. + - If your entry needs to be reviewed, select **In review** in the **Status** drop-down to open a review PR. For more information on managing review PRs, see step 3 in the [Create a What's new entry](#create-a-whats-new-entry). + +If your entry is already live in both _What's new in Cloud_ and _What's new in Grafana vxx_, or it's after the cut-off date for a versioned release, update the CMS and then reach out to the person responsible for creating the versioned release notes. ### Create the versioned release notes -1. After the previous version of Grafana is released, the DRI cuts a branch and creates a draft PR with an empty What's new doc to be populated with the What's new content for the next release, along with the updated What's new index page. This PR: +1. After the previous version of Grafana is released, the directly responsible individual (DRI) cuts a branch and creates a draft PR with an empty What's new doc to be populated with the What's new content for the next release, along with the updated What's new index page. This PR: - Should include an update to the link and version number located on the What's new tile of `docs/sources/_index.md`. - Should include the new Upgrade Guide page. - Should have a `no-backport` label. - May include a new Breaking changes guide page. -1. After the cut-off date for the self-managed/versioned release, the DRI goes [where] and filters the What's new content in the CMS by the following properties: - -- Self-managed editions -- Date range (from the previous release to the current date) +1. After the cut-off date for the self-managed/versioned release, the DRI collects the relevant What's new content (specifics TBD). 1. The DRI adds this content to the What's new doc using the tags data to group items appropriately. @@ -96,18 +111,18 @@ If your entry is published in both _What's new in Cloud_ and _What's new in Graf 1. PM and the DRI work to make final adjustments to the Upgrade guide or Breaking changes guide. -1. A week before the release date, the the DRI changes the PR status from **Draft** to **Ready for Review** to signal to other stakeholders that the PR is now ready for any further review. +1. A week before the release date, the DRI changes the PR status from **Draft** to **Ready for Review** to signal to other stakeholders that the PR is now ready for any further review. 1. The DRI finalizes the What's new. 1. The DRI coordinates with the Release Guild and the GTM team for precise timing of when to merge the What's new doc into `main`. -1. On release day, the DRI and merges the What's new branch into `main`. If `main` is no longer the same release as the upcoming release, the DRI should add the appropriate backport label to the PR. +1. On release day, the DRI and merges the What's new branch into `main`. If `main` is no longer the same release as the upcoming release, the DRI adds the appropriate backport label to the PR. -The What's new is published in the "next" docs. +The What's new is live in the "next" docs. When the release branch is promoted to GA, the What's new will also be part of the "latest" doc set. From 66fb38010f189ff7a0cb14317b752c0823f8e81c Mon Sep 17 00:00:00 2001 From: Isabel Matwawana Date: Thu, 23 Nov 2023 11:32:24 -0500 Subject: [PATCH 20/24] Added enablement video in step 1 --- .../contribute-documentation/contribute-release-notes/index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/sources/contribute-documentation/contribute-release-notes/index.md b/docs/sources/contribute-documentation/contribute-release-notes/index.md index eaf361923..3ff4fbd86 100644 --- a/docs/sources/contribute-documentation/contribute-release-notes/index.md +++ b/docs/sources/contribute-documentation/contribute-release-notes/index.md @@ -46,8 +46,8 @@ When you’re ready to add a What’s new entry, complete the following steps: - **TAGS (OPTIONAL)** - Select category tags that users can use to filter their view. Select as many as apply. - **CLOUD AVAILABILITY** - Select the stage of the feature’s Cloud release. If the feature isn't available in Cloud, select "None." - **CLOUD OFFERING** - Select which account types have access to the feature. If the feature isn't available in Cloud, select "None." - - **SELF-MANAGED AVAILABILITY** - Select the stage of the feature's self-managed release. If the feature isn't available in self-managed Grafana, select "None." - **SELF-MANAGED EDITIONS** - Select the on-premises offerings where this feature is available. If the feature isn't available in self-managed Grafana, select "None." + - **SELF-MANAGED AVAILABILITY** - Select the stage of the feature's self-managed release. If the feature isn't available in self-managed Grafana, select "None." - **BODY** - Include an overview of the feature and the problem it solves. If you want to view some best practices around what to write here, see Writing guidelines for what’s new below. @@ -58,6 +58,7 @@ When you’re ready to add a What’s new entry, complete the following steps: - **DOCUMENTATION URL (OPTIONAL)** - URL to the public documentation for this feature. - **GRAFANA URL PATH (OPTIONAL)** - URL path to the feature in a Grafana Cloud stack. For example, `/alerting/notifications`. - **INTERNAL INFORMATION (OPTIONAL)** - Information for Grafana Labs employees only. For example, ProductDNA, slack channel, FAQ, training docs or videos. Used for training and internal announcements. + - **ENABLEMENT VIDEO (OPTIONAL)** - Link to the video used for enablement. 1. Click **Save**. The entry is now in **Draft** status. 1. If your entry is ready to publish, proceed to step 4. If your entry requires review, follow these steps: From 31f3af8ccc7f686fc188e628554646a40b9c3a98 Mon Sep 17 00:00:00 2001 From: Isabel Matwawana Date: Thu, 23 Nov 2023 11:36:34 -0500 Subject: [PATCH 21/24] Ran prettier --- .../contribute-release-notes/index.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/sources/contribute-documentation/contribute-release-notes/index.md b/docs/sources/contribute-documentation/contribute-release-notes/index.md index 3ff4fbd86..d3fff3bfc 100644 --- a/docs/sources/contribute-documentation/contribute-release-notes/index.md +++ b/docs/sources/contribute-documentation/contribute-release-notes/index.md @@ -28,8 +28,8 @@ Release notes should be entered into the CMS 2-4 weeks before the feature is ava Note that in the context of the CMS, the word "published" has a slightly different meaning than in general use: - - **Published** - Your entry is complete and in **Published** status. It's either visible on the external _What's new in Cloud_ page or is going to automatically become visible on the release date. - - **Live** - Your entry is visible on the _What's new in Cloud_ page. +- **Published** - Your entry is complete and in **Published** status. It's either visible on the external _What's new in Cloud_ page or is going to automatically become visible on the release date. +- **Live** - Your entry is visible on the _What's new in Cloud_ page. ### Create a What's new entry @@ -39,8 +39,8 @@ When you’re ready to add a What’s new entry, complete the following steps: - **FEATURE NAME** - Short headline for the improvement. For example, “Grafana OnCall integration for Alerting.” - **DATE** - Date and time (UTC) that you want this note to be live. This should also be the feature release date. - - If you’ve opened a review PR, you must merge it before the date/time you've added here. If you enter a date that has passed, the note is published immediately with that date. + + If you’ve opened a review PR, you must merge it before the date/time you've added here. If you enter a date that has passed, the note is published immediately with that date. - **CONTACT** - First and last name. The contents of this field aren't publicly viewable. - **TAGS (OPTIONAL)** - Select category tags that users can use to filter their view. Select as many as apply. @@ -90,8 +90,8 @@ Regardless of the status of your entry, it's always best to use the CMS to make 1. Click **Save**. The entry is now in **Draft** status. 1. Do one of the following: - - If your entry is ready to publish, select **Ready** in the **Status** drop-down, and then **Publish now** in the **Publish** drop-down. - - If your entry needs to be reviewed, select **In review** in the **Status** drop-down to open a review PR. For more information on managing review PRs, see step 3 in the [Create a What's new entry](#create-a-whats-new-entry). + - If your entry is ready to publish, select **Ready** in the **Status** drop-down, and then **Publish now** in the **Publish** drop-down. + - If your entry needs to be reviewed, select **In review** in the **Status** drop-down to open a review PR. For more information on managing review PRs, see step 3 in the [Create a What's new entry](#create-a-whats-new-entry). If your entry is already live in both _What's new in Cloud_ and _What's new in Grafana vxx_, or it's after the cut-off date for a versioned release, update the CMS and then reach out to the person responsible for creating the versioned release notes. From 544908cc182bb5456ca2f13dd24f9d97778aed26 Mon Sep 17 00:00:00 2001 From: Isabel <76437239+imatwawana@users.noreply.github.com> Date: Thu, 23 Nov 2023 11:41:29 -0500 Subject: [PATCH 22/24] Fix vale error Co-authored-by: Jack Baldry --- .../contribute-documentation/contribute-release-notes/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/contribute-documentation/contribute-release-notes/index.md b/docs/sources/contribute-documentation/contribute-release-notes/index.md index d3fff3bfc..52853904a 100644 --- a/docs/sources/contribute-documentation/contribute-release-notes/index.md +++ b/docs/sources/contribute-documentation/contribute-release-notes/index.md @@ -93,7 +93,7 @@ Regardless of the status of your entry, it's always best to use the CMS to make - If your entry is ready to publish, select **Ready** in the **Status** drop-down, and then **Publish now** in the **Publish** drop-down. - If your entry needs to be reviewed, select **In review** in the **Status** drop-down to open a review PR. For more information on managing review PRs, see step 3 in the [Create a What's new entry](#create-a-whats-new-entry). -If your entry is already live in both _What's new in Cloud_ and _What's new in Grafana vxx_, or it's after the cut-off date for a versioned release, update the CMS and then reach out to the person responsible for creating the versioned release notes. +If your entry is already live in both _What's new in Cloud_ and _What's new in Grafana `vMAJOR.MINOR.x`_, or it's after the cut-off date for a versioned release, update the CMS and then reach out to the person responsible for creating the versioned release notes. ### Create the versioned release notes From 41dcb87c0412e5231d7e36011b9c973155f42798 Mon Sep 17 00:00:00 2001 From: Isabel <76437239+imatwawana@users.noreply.github.com> Date: Mon, 27 Nov 2023 14:20:50 -0500 Subject: [PATCH 23/24] Change office hours links to meeting notes Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com> --- .../contribute-release-notes/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sources/contribute-documentation/contribute-release-notes/index.md b/docs/sources/contribute-documentation/contribute-release-notes/index.md index 52853904a..af2fe2e72 100644 --- a/docs/sources/contribute-documentation/contribute-release-notes/index.md +++ b/docs/sources/contribute-documentation/contribute-release-notes/index.md @@ -67,8 +67,8 @@ When you’re ready to add a What’s new entry, complete the following steps: A review PR is generated in the `grafana/website` repository. **The Documentation Team does not automatically review these requests; teams that create What’s new entries are responsible for determining their own review process.** However, there are two weekly Office Hours meetings offered by the Documentation Team that you’re welcome to attend for guidance and assistance: - - [Docs squad office hours (early)](https://calendar.google.com/calendar/event?action=TEMPLATE&tmeid=NmoxZ2w0NHBoazgxaW80cTN0MW82aG1xMmxfMjAyMzExMjJUMDkwMDAwWiBpc2FiZWwubWF0d2F3YW5hQGdyYWZhbmEuY29t&tmsrc=isabel.matwawana%40grafana.com&scp=ALL) - - [Docs squad office hours (late)](https://calendar.google.com/calendar/event?action=TEMPLATE&tmeid=NTI0MWZxYTYwY3FjYW5waWM1OWVjMDBkaWpfMjAyMzExMjJUMjEwMDAwWiBpc2FiZWwubWF0d2F3YW5hQGdyYWZhbmEuY29t&tmsrc=isabel.matwawana%40grafana.com&scp=ALL) + - [Docs squad office hours (early)](https://docs.google.com/document/d/1QaH9PwIZ_6-6Udhmy7Zhwme72ZZLqSTiX8HYFFi6AE4/edit#heading=h.9o53ccbx7xrw) + - [Docs squad office hours (late)](https://docs.google.com/document/d/12XK3XYEZWU3uIPluq3sn5HSGqWHBHJkktqlyQZHj_Uw/edit#heading=h.9o53ccbx7xrw) 1. Merge your PR in time for your feature release date. From aa8d6513532611089dee85fb50302bd959bbfe45 Mon Sep 17 00:00:00 2001 From: Isabel <76437239+imatwawana@users.noreply.github.com> Date: Mon, 27 Nov 2023 14:57:20 -0500 Subject: [PATCH 24/24] Small change to try to nudge checks into running --- .../contribute-release-notes/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sources/contribute-documentation/contribute-release-notes/index.md b/docs/sources/contribute-documentation/contribute-release-notes/index.md index af2fe2e72..855d5edb8 100644 --- a/docs/sources/contribute-documentation/contribute-release-notes/index.md +++ b/docs/sources/contribute-documentation/contribute-release-notes/index.md @@ -108,9 +108,9 @@ If your entry is already live in both _What's new in Cloud_ and _What's new in G 1. The DRI adds this content to the What's new doc using the tags data to group items appropriately. -1. PM reviews the content to adjust order, **but not copy**. All copy editing must take place when entries are added in the CMS. +1. The PM reviews the content to adjust order, **but not copy**. All copy editing must take place when entries are added in the CMS. -1. PM and the DRI work to make final adjustments to the Upgrade guide or Breaking changes guide. +1. The PM and the DRI work to make final adjustments to the Upgrade guide or Breaking changes guide. 1. A week before the release date, the DRI changes the PR status from **Draft** to **Ready for Review** to signal to other stakeholders that the PR is now ready for any further review.