Docs: fix broken link to moved content (#77147)

* Remove docs/reference shortcode for moved content

* Updated transformers content file

* Updated README.md to make Transformations section more prominent

* Updated index file to make super clear where you must update this content

* Added doc/ref back in with new format

* Removed bracket

* Added missing quotation marks

* Added reference style link and removed link from docs/ref shortcode

* Updated link

* Add warning to only use reference style links in content.ts

* ihm/251023-link-fix/ update scripts/docs/generate-transformations.ts with proposed changes, and build markdown

* ihm/251023-link-fix/ build docs

* Fix extraneous whitespace

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Add precheck for ONESHELL support

Otherwise the recipe doesn't work.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: jev forsberg <jev.forsberg@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
This commit is contained in:
Isabel
2023-10-25 14:09:33 -04:00
committed by GitHub
parent 39a30b0c01
commit 89f63dcddb
4 changed files with 44 additions and 17 deletions

View File

@@ -1,6 +1,14 @@
---
comments: |
This Markdown file is auto-generated. Do not edit this file directly.
This Markdown file is auto-generated. DO NOT EDIT THIS FILE DIRECTLY.
To update this Markdown, navigate to the following Typescript files and edit them based on what you need to update:
scripts/docs/generate-transformations.ts - Includes all content not specific to a transformation.
public/app/features/transformers/docs/content.ts - Transformation-specific content.
Only use reference style links in the 'content.ts' file or else link text will be visible in the UI.
To build this Markdown, do the following:
$ cd /docs (from the root of the repository)
@@ -1103,9 +1111,6 @@ For each generated "Trend" field value calculation function can be selected. Def
[Table panel]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/panels-visualizations/visualizations/table"
[Table panel]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/panels-visualizations/visualizations/table"
[Data frames]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/developers/plugins/introduction-to-plugin-development/data-frames"
[Data frames]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/developers/plugins/introduction-to-plugin-development/data-frames"
[Calculation types]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/panels-visualizations/calculation-types"
[Calculation types]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/panels-visualizations/calculation-types"
@@ -1128,3 +1133,5 @@ For each generated "Trend" field value calculation function can be selected. Def
[dashboard variable]: "/docs/grafana-cloud/ -> docs/grafana/<GRAFANA VERSION>/dashboards/variables"
{{% /docs/reference %}}
[Data frames]: https://grafana.com/developers/plugin-tools/introduction/data-frames/