From da43d5ae57cb9fcc3ea186a362ab0e505314d66b Mon Sep 17 00:00:00 2001 From: Andy McHugh Date: Wed, 21 Feb 2024 21:21:55 +0000 Subject: [PATCH] move all references from docs to here --- README.md | 2 +- examples/panelConfig1.yaml | 2 +- examples/panelConfigGrafanaVariables.yaml | 2 +- ...elConfigGrafanaVariablesWithDataRefOverrides.yaml | 2 +- examples/panelConfigRandomWalk.yaml | 2 +- provisioning/dashboards/dashboard1_FlowPanel.json | 12 ++++++------ .../dashboards/dashboard2_GrafanaVariables.json | 8 ++++---- provisioning/dashboards/dashboard3_RandomWalk.json | 12 ++++++------ src/components/DebuggingEditor.tsx | 2 +- src/module.ts | 4 ++-- 10 files changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 5d42735..1ba0fae 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ The plugin was created from this [grafana template](https://grafana.com/develope ![example2](src/img/example2.png) ## Getting started with creating panels -Go to the [documentation](https://github.com/andymchugh/andrewbmchugh-flow-panel-docs/blob/main/README.md) repository for full details on how to use the panel. +Go to the [documentation](https://github.com/andymchugh/andrewbmchugh-flow-panel/blob/main/README.md) repository for full details on how to use the panel. ## Getting started with adding new features Go to the [Grafana Getting Started](./grafana-getting-started.md) guide to get going with downloading a fork and setting up your test environment. diff --git a/examples/panelConfig1.yaml b/examples/panelConfig1.yaml index ec82289..bbfbdc8 100644 --- a/examples/panelConfig1.yaml +++ b/examples/panelConfig1.yaml @@ -18,7 +18,7 @@ cells: url: "https://app.diagrams.net/?p=svgdata" docs: link: - url: "https://github.com/andymchugh/andrewbmchugh-flow-panel-docs/blob/main/README.md" + url: "https://github.com/andymchugh/andrewbmchugh-flow-panel/blob/main/README.md" inbox_depth: dataRef: "test-data-large-sin" label: diff --git a/examples/panelConfigGrafanaVariables.yaml b/examples/panelConfigGrafanaVariables.yaml index 830f743..d30520e 100644 --- a/examples/panelConfigGrafanaVariables.yaml +++ b/examples/panelConfigGrafanaVariables.yaml @@ -43,7 +43,7 @@ cells: url: "https://app.diagrams.net/?p=svgdata" docs: link: - url: "https://github.com/andymchugh/andrewbmchugh-flow-panel-docs/blob/main/README.md" + url: "https://github.com/andymchugh/andrewbmchugh-flow-panel/blob/main/README.md" inbox_depth: dataRef: "test-data-large-cos" label: diff --git a/examples/panelConfigGrafanaVariablesWithDataRefOverrides.yaml b/examples/panelConfigGrafanaVariablesWithDataRefOverrides.yaml index f353461..7198541 100644 --- a/examples/panelConfigGrafanaVariablesWithDataRefOverrides.yaml +++ b/examples/panelConfigGrafanaVariablesWithDataRefOverrides.yaml @@ -48,7 +48,7 @@ cells: url: "https://app.diagrams.net/?p=svgdata" docs: link: - url: "https://github.com/andymchugh/andrewbmchugh-flow-panel-docs/blob/main/README.md" + url: "https://github.com/andymchugh/andrewbmchugh-flow-panel/blob/main/README.md" inbox_depth: dataRef: "test-data-large-cos" label: diff --git a/examples/panelConfigRandomWalk.yaml b/examples/panelConfigRandomWalk.yaml index 4a0ee19..d2cadfd 100644 --- a/examples/panelConfigRandomWalk.yaml +++ b/examples/panelConfigRandomWalk.yaml @@ -22,7 +22,7 @@ cells: url: "https://app.diagrams.net/?p=svgdata" docs: link: - url: "https://github.com/andymchugh/andrewbmchugh-flow-panel-docs/blob/main/README.md" + url: "https://github.com/andymchugh/andrewbmchugh-flow-panel/blob/main/README.md" inbox_depth: dataRef: "A-series" label: diff --git a/provisioning/dashboards/dashboard1_FlowPanel.json b/provisioning/dashboards/dashboard1_FlowPanel.json index a23726b..727cb9f 100644 --- a/provisioning/dashboards/dashboard1_FlowPanel.json +++ b/provisioning/dashboards/dashboard1_FlowPanel.json @@ -40,7 +40,7 @@ "showLineNumbers": false, "showMiniMap": false }, - "content": "# The Flow Panel\n\nThis dashboard along with the two companion dashboards demonstrate the core functionality of the Flow panel:\n|Features|Features|Features|Features|\n|--------|--------|--------|--------|\n|label content|panel config|units|time-slider|\n|label color|site config|tooltips|url links|\n|fill color|variable config overrides|auto-scaling|hue gradient|\n\n\nThe first panel is what you get out-the-box when you create a FLow panel. A basic SVG driven\nfrom test data via sample config. It shows everything working and is the starting point\nfor someone to go exploring. How they should explore is explained in the\n[Docs](https://github.com/andymchugh/andrewbmchugh-flow-panel-docs/blob/main/README.md) which are\nreachable from the SVG widget as well as the 'Docs' button in the Debugging section of\nthe editor.\n\nThe second panel shows a more typical usage to give a sense of the range of widget support\nyou get from using a product like draw.io. It's more aspirational, helping them reason\nabout how to apply it to their own architecture and see the benefits of a shared siteConfig\nin terms of data maintenance.\n", + "content": "# The Flow Panel\n\nThis dashboard along with the two companion dashboards demonstrate the core functionality of the Flow panel:\n|Features|Features|Features|Features|\n|--------|--------|--------|--------|\n|label content|panel config|units|time-slider|\n|label color|site config|tooltips|url links|\n|fill color|variable config overrides|auto-scaling|hue gradient|\n\n\nThe first panel is what you get out-the-box when you create a FLow panel. A basic SVG driven\nfrom test data via sample config. It shows everything working and is the starting point\nfor someone to go exploring. How they should explore is explained in the\n[Docs](https://github.com/andymchugh/andrewbmchugh-flow-panel/blob/main/README.md) which are\nreachable from the SVG widget as well as the 'Docs' button in the Debugging section of\nthe editor.\n\nThe second panel shows a more typical usage to give a sense of the range of widget support\nyou get from using a product like draw.io. It's more aspirational, helping them reason\nabout how to apply it to their own architecture and see the benefits of a shared siteConfig\nin terms of data maintenance.\n", "mode": "markdown" }, "pluginVersion": "10.0.3", @@ -59,9 +59,9 @@ }, "id": 123125, "options": { - "panelConfig": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel-docs/main/examples/panelConfig1.yaml", + "panelConfig": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel/main/examples/panelConfig1.yaml", "siteConfig": "", - "svg": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel-docs/main/examples/darkThemeSvg1.svg", + "svg": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel/main/examples/darkThemeSvg1.svg", "testDataEnabled": true, "timeSliderEnabled": true, "debuggingCtr": { @@ -84,9 +84,9 @@ }, "id": 123126, "options": { - "panelConfig": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel-docs/main/examples/panelConfig2.yaml", - "siteConfig": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel-docs/main/examples/siteConfig.yaml", - "svg": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel-docs/main/examples/darkThemeSvg2.svg", + "panelConfig": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel/main/examples/panelConfig2.yaml", + "siteConfig": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel/main/examples/siteConfig.yaml", + "svg": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel/main/examples/darkThemeSvg2.svg", "testDataEnabled": true, "timeSliderEnabled": true, "debuggingCtr": { diff --git a/provisioning/dashboards/dashboard2_GrafanaVariables.json b/provisioning/dashboards/dashboard2_GrafanaVariables.json index 1c3c2e6..6b32fa9 100644 --- a/provisioning/dashboards/dashboard2_GrafanaVariables.json +++ b/provisioning/dashboards/dashboard2_GrafanaVariables.json @@ -89,9 +89,9 @@ "dataCtr": 0, "mappingsCtr": 0 }, - "panelConfig": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel-docs/main/examples/panelConfigGrafanaVariables.yaml", + "panelConfig": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel/main/examples/panelConfigGrafanaVariables.yaml", "siteConfig": "", - "svg": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel-docs/main/examples/darkThemeSvg1.svg", + "svg": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel/main/examples/darkThemeSvg1.svg", "testDataEnabled": true, "timeSliderEnabled": true, "debuggingCtr": { @@ -119,9 +119,9 @@ "dataCtr": 0, "mappingsCtr": 0 }, - "panelConfig": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel-docs/main/examples/panelConfigGrafanaVariablesWithDataRefOverrides.yaml", + "panelConfig": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel/main/examples/panelConfigGrafanaVariablesWithDataRefOverrides.yaml", "siteConfig": "", - "svg": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel-docs/main/examples/darkThemeSvg1.svg", + "svg": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel/main/examples/darkThemeSvg1.svg", "testDataEnabled": true, "timeSliderEnabled": true, "debuggingCtr": { diff --git a/provisioning/dashboards/dashboard3_RandomWalk.json b/provisioning/dashboards/dashboard3_RandomWalk.json index e37e1ae..01b757e 100644 --- a/provisioning/dashboards/dashboard3_RandomWalk.json +++ b/provisioning/dashboards/dashboard3_RandomWalk.json @@ -60,9 +60,9 @@ }, "id": 123127, "options": { - "panelConfig": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel-docs/main/examples/panelConfigRandomWalk.yaml", + "panelConfig": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel/main/examples/panelConfigRandomWalk.yaml", "siteConfig": "", - "svg": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel-docs/main/examples/darkThemeSvg1.svg", + "svg": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel/main/examples/darkThemeSvg1.svg", "testDataEnabled": true, "timeSliderEnabled": true, "debuggingCtr": { @@ -106,9 +106,9 @@ }, "id": 123129, "options": { - "panelConfig": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel-docs/main/examples/panelConfigRandomWalk.yaml", + "panelConfig": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel/main/examples/panelConfigRandomWalk.yaml", "siteConfig": "", - "svg": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel-docs/main/examples/darkThemeSvg1.svg", + "svg": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel/main/examples/darkThemeSvg1.svg", "testDataEnabled": false, "timeSliderEnabled": true, "debuggingCtr": { @@ -144,9 +144,9 @@ }, "id": 123128, "options": { - "panelConfig": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel-docs/main/examples/panelConfigRandomWalk.yaml", + "panelConfig": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel/main/examples/panelConfigRandomWalk.yaml", "siteConfig": "", - "svg": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel-docs/main/examples/darkThemeSvg1.svg", + "svg": "https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel/main/examples/darkThemeSvg1.svg", "testDataEnabled": false, "timeSliderEnabled": true, "debuggingCtr": { diff --git a/src/components/DebuggingEditor.tsx b/src/components/DebuggingEditor.tsx index a5589ba..b68c831 100644 --- a/src/components/DebuggingEditor.tsx +++ b/src/components/DebuggingEditor.tsx @@ -7,7 +7,7 @@ import { SvgHolder } from 'components/SvgUpdater'; import { TimeSeriesData } from 'components/TimeSeries'; function displayDocs() { - window.open('https://github.com/andymchugh/andrewbmchugh-flow-panel-docs/blob/main/README.md'); + window.open('https://github.com/andymchugh/andrewbmchugh-flow-panel/blob/main/README.md'); } function displayUnits() { diff --git a/src/module.ts b/src/module.ts index a7e787a..53ef69b 100644 --- a/src/module.ts +++ b/src/module.ts @@ -13,7 +13,7 @@ export const plugin = new PanelPlugin(FlowPanel).setPanelOptions((b path: 'svg', name: 'SVG', description: `This holds the SVG element or a url to the SVG element.`, - defaultValue: 'https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel-docs/main/examples/' + svgName, + defaultValue: 'https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel/main/examples/' + svgName, settings: { useTextarea: true, rows: 2, @@ -23,7 +23,7 @@ export const plugin = new PanelPlugin(FlowPanel).setPanelOptions((b path: 'panelConfig', name: 'Panel Config', description: `YAML file containing the panel config.`, - defaultValue: 'https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel-docs/main/examples/panelConfig1.yaml', + defaultValue: 'https://raw.githubusercontent.com/andymchugh/andrewbmchugh-flow-panel/main/examples/panelConfig1.yaml', settings: { useTextarea: true, rows: 2,