mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
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 <jack.baldry@grafana.com> * 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 <jack.baldry@grafana.com> --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
This commit is contained in:
parent
e81f6a7b0b
commit
19a993b815
74
docs/sources/whatsnew/whats-new-next/README.md
Normal file
74
docs/sources/whatsnew/whats-new-next/README.md
Normal file
@ -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 `<VARIABLE>` with the appropriate text (explained after the template):
|
||||
|
||||
```markdown
|
||||
## <FEATURE>
|
||||
|
||||
<!-- <CONTRIBUTOR> -->
|
||||
<!-- <ON-PREMISE OFFERING> -->
|
||||
|
||||
_Available in <CLOUD AVAILABILITY> in Grafana <CLOUD OFFERING>_
|
||||
|
||||
<DESCRIPTION>
|
||||
```
|
||||
|
||||
## _`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
|
||||
|
||||
<!-- Jack Baldry -->
|
||||
<!-- OSS, Enterprise -->
|
||||
|
||||
_Available in public preview in Grafana Cloud Pro and Advanced_
|
||||
|
||||
The navigation in Grafana Cloud has been updated in the following ways...
|
||||
```
|
@ -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.
|
||||
|
||||
<!-- Template below
|
||||
## Feature
|
||||
<!-- Name of contributor commented out -->
|
||||
<!-- Availability in OSS and Enterprise (for later) commented out -->
|
||||
<!-- [Generally available | Available in private/public preview | Experimental] in Grafana [Cloud Free | Cloud Pro | Cloud Advanced | Cloud]
|
||||
Description. Include an overview of the feature and problem it solves, and where to learn more (like a link to the docs).
|
||||
{{% admonition type="note" %}}
|
||||
You must use relative references when linking to docs within the Grafana repo. Please do not use absolute URLs. For more information about relrefs, refer to [Links and references](/docs/writers-toolkit/writing-guide/references/).
|
||||
{{% /admonition %}}
|
||||
-->
|
||||
|
Loading…
Reference in New Issue
Block a user