Transformations: Separate useful doc content for UI use (grafana#75781)

* baldm0mma/doc_builder/ add to gitignore

* baldm0mma/doc_builder/ add makefile commands

* baldm0mma/doc_builder/ add content

* baldm0mma/doc_builder/ format content

* baldm0mma/doc_builder/ update makefile

* baldm0mma/docs_builder/ update content

* baldm0mma/doc_builder/ add back content

* baldm0mma/doc_builder/ run builder

* baldm0mma/doc_builder/ update naming

* baldm0mma/doc_builder/ remove unused note

* baldm0mma/doc_builder/ update template

* baldm0mma/doc_builder/ add new line in makefile

* baldm0mma/doc_builder/ rem new line

* baldm0mma/doc_builder/ add final line

* Much of this full PR was Co-Authored-By: Jack Baldry <jack.baldry@grafana.com>

* baldm0mma/doc_builder/ update readme

* baldm0mma/doc_builder/ update guidlines

* Update scripts/docs/generate-transformations.ts

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Update scripts/docs/generate-transformations.ts

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Update scripts/docs/generate-transformations.ts

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Update scripts/docs/generate-transformations.ts

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Update scripts/docs/generate-transformations.ts

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Update docs/README.md

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Update docs/README.md

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Update scripts/docs/generate-transformations.ts

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* baldm0mma/doc_builder/ update concat

* baldmomma/doc_builder/ finish concat table

* baldm0mma/docs_builder/ update with suggestions

* baldm0mma/doc_builder/ update content to use getHelperDocs

* baldm0mma/doc_builder/ update calculateField

* baldm0mma/doc_builder/ update to byRefId

* baldm0mma/doc_builder/ update filterByValue

* baldm0mma/doc_builder/ update filterFieldsByName

* baldm0mma/doc_builder/ update formatTime

* baldm0mma/doc_builder/ update groupBy

* baldm0mma/doc_builder/ update groupingToMatrix

* baldm0mma/doc_update/ update heatmap

* baldm0mma/doc_builder/ update histogram

* baldm0mma/doc_builder/ update joinByField

* baldm0mma/doc_builder/ update joinByLabels

* baldm0mma/doc_builder/ update labelsToFields

* baldm0mma/doc_builder/ update limit

* baldm0mma/doc_builder/ update merge

* baldm0mma/doc_builder/ update organize

* baldm0mma/doc_builder/ update partitionByValues

* baldm0mma/doc_builder/ update prepareTimeSeries

* baldm0mma/doc_builder/ update reduce

* baldm0mma/doc_builder/ update renameByRegex

* baldm0mma/doc_builder/ update rowsToFields

* baldm0mma/doc_builder/ update seriesToRows

* baldm0mma/doc_builder/ update sortBy

* baldm0mma/doc_builder/ update spatial

* baldm0mma/doc_builder/ update timeSeriesTable

* baldm0mma/doc_builder/ rerender all

* baldm0mma/doc_builder/ update calculateField

* baldm0mma/doc_builder/ gitignore conflicts

* baldm0mma/doc_builder/ add formatString

* baldm0mma/doc_builder/ update vars

* baldm0mma/doc_builder/ update naming

* baldm0mma/doc_builder/ rerender markdown

* Update public/app/features/transformers/docs/content.ts

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* baldm0mma/doc_builder/ update content

* baldm0mma/doc_builder/ add to codeownders

* baldm0mma/doc_builder/ correct spelling

* baldm0mma/doc_builder/ update comment

---------

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

Author: baldm0mma

.github/CODEOWNERS

@@ -513,6 +513,7 @@ cypress.config.js @grafana/grafana-frontend-platform
 /scripts/verify-repo-update/ @grafana/grafana-delivery
 scripts/generate-icon-bundle.js @grafana/plugins-platform-frontend @grafana/grafana-frontend-platform
 
+/scripts/docs/generate-transformations.ts @grafana/grafana-bi-squad
 /scripts/webpack/ @grafana/frontend-ops
 /scripts/generate-a11y-report.sh @grafana/grafana-frontend-platform
 .pa11yci.conf.js @grafana/grafana-frontend-platform

.gitignore

@@ -202,4 +202,8 @@ deployment_tools_config.json
 .pr-body.txt
 
 # Core plugin builds
-public/app/plugins/**/dist/
+public/app/plugins/**/dist/
+
+# Ignore transpiled JavaScript resulting from the generate-transformations.ts script.
+/public/app/features/transformers/docs/*.js
+/scripts/docs/generate-transformations.js

docs/Makefile

@@ -6,3 +6,11 @@ MAKEFLAGS += --warn-undefined-variables
 MAKEFLAGS += --no-builtin-rule
 
 include docs.mk
+
+.PHONY: sources/panels-visualizations/query-transform-data/transform-data/index.md
+sources/panels-visualizations/query-transform-data/transform-data/index.md: ## Generate the Transform Data page source.
+sources/panels-visualizations/query-transform-data/transform-data/index.md:
+	cd $(CURDIR)/..
+	npx tsc ../scripts/docs/generate-transformations.ts
+	node ../scripts/docs/generate-transformations.js > $(CURDIR)/$@
+	npx prettier -w $(CURDIR)/$@

docs/README.md

@@ -23,7 +23,17 @@ If you have the grafana/website repo checked out in the same directory as the gr
 
 ## Content guidelines
 
-Edit content in the `sources` directory.
+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.
+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.
 
 ### [Contributing](/contribute/documentation/README.md)