public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files
docs/README.md
+13 -7
View File
@@ -25,15 +25,21 @@ If you have the grafana/website repo checked out in the same directory as the gr
Generally, one can edit content in the `sources` directory.
NOTE: the following paths are built instead from a typescript file and are auto-generated. Please do not edit these files directly.
The following paths are built instead from a typescript file and are auto-generated. Please do not edit these files directly.
Instead, navigate to the appropriate typescript source file and edit the content there, then follow the build instructions to generate the markdown files.
- Transformations
- Auto-generated markdown location:
- docs/sources/panels-visualizations/query-transform-data/transform-data/index.md
- Typescript location for editing and instructions:
- scripts/docs/generate-transformations.ts - Includes all content not specific to a transformation.
- public/app/features/transformers/docs/content.ts - Transformation-specific content.
### Transformations
Auto-generated markdown location:
- docs/sources/panels-visualizations/query-transform-data/transform-data/index.md
Typescript location for editing and instructions:
- 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](https://grafana.com/docs/writers-toolkit/write/shortcodes/#docsreference) in the `content.ts` file or else link text will be visible in the UI.
### [Contributing](/contribute/documentation/README.md)