From 19a993b81543b54ca75fe9e9d17f8ebaf8a8c698 Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Wed, 23 Aug 2023 12:12:16 +0100 Subject: [PATCH] Add README for 'What's New in Grafana Cloud' contributions (#73403) * Add README for 'What's New in Grafana Cloud' contributions Signed-off-by: Jack Baldry * Apply suggestions from code review Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * Use more consistent variable names * Reconcile template and example Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * Add highlighting to example * Be explict about cloud offering options Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * Prettier Signed-off-by: Jack Baldry --------- Signed-off-by: Jack Baldry Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> --- .../sources/whatsnew/whats-new-next/README.md | 74 +++++++++++++++++++ docs/sources/whatsnew/whats-new-next/index.md | 11 --- 2 files changed, 74 insertions(+), 11 deletions(-) create mode 100644 docs/sources/whatsnew/whats-new-next/README.md diff --git a/docs/sources/whatsnew/whats-new-next/README.md b/docs/sources/whatsnew/whats-new-next/README.md new file mode 100644 index 00000000000..3c40a068b64 --- /dev/null +++ b/docs/sources/whatsnew/whats-new-next/README.md @@ -0,0 +1,74 @@ +# Contribute to 'What's New in Grafana Cloud' + +To have a feature presented in [What's New in Grafana Cloud](https://grafana.com/docs/grafana-cloud/whatsnew/), add an entry to the [`index.md`](./index.md) file in this directory. + +Use the following template, replace any `` with the appropriate text (explained after the template): + +```markdown +## + + + + +_Available in in Grafana _ + + +``` + +## _`CONTRIBUTOR`_ + +The name of the contributor of the feature. +The information is intentionally commented out so that it isn't displayed in the published page. + +## _`ON-PREMISE OFFERING`_ + +One or both of: + +- OSS +- Enterprise + +Intended availability of the feature when released outside of Grafana Cloud. +The information is intentionally commented out so that it isn't displayed in the published page. +If the feature is not going to be released outside of Grafana Cloud, omit the HTML comment entirely. + +## _`CLOUD AVAILABILITY`_ + +One of the following [release life cycle stages](https://grafana.com/docs/release-life-cycle/): + +- Generally available +- Available in public preview +- Available in private preview +- Experimental + +## _`CLOUD OFFERING`_ + +List the appropriate combination of: + +- Cloud Free +- Cloud Pro +- Cloud Advanced + +Or if all three: + +- Cloud + +## _`DESCRIPTION`_ + +Include an overview of the feature and problem it solves, and where to learn more. +Link to any appropriate documentation. +You must use relative path references when linking to documentation within the Grafana repository. +Use the Hugo `relref` shortcode for build time link checking. +For more information about the `relref` shortcode, refer to [Links and references](https://grafana.com/docs/writers-toolkit/writing-guide/references/). + +## Example + +```markdown +## Updated navigation + + + + +_Available in public preview in Grafana Cloud Pro and Advanced_ + +The navigation in Grafana Cloud has been updated in the following ways... +``` diff --git a/docs/sources/whatsnew/whats-new-next/index.md b/docs/sources/whatsnew/whats-new-next/index.md index 7fe0f4092de..cdcedc0181b 100644 --- a/docs/sources/whatsnew/whats-new-next/index.md +++ b/docs/sources/whatsnew/whats-new-next/index.md @@ -16,14 +16,3 @@ weight: -37 # What’s new in Grafana Cloud Welcome to Grafana Cloud! Read on to learn about the newest changes to Grafana Cloud. - - - -