Skip to content

Commit

Permalink
move all references from docs to here
Browse files Browse the repository at this point in the history
  • Loading branch information
andymchugh committed Feb 21, 2024
1 parent da1c568 commit da43d5a
Show file tree
Hide file tree
Showing 10 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion examples/panelConfig1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion examples/panelConfigGrafanaVariables.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion examples/panelConfigRandomWalk.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
12 changes: 6 additions & 6 deletions provisioning/dashboards/dashboard1_FlowPanel.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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": {
Expand All @@ -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": {
Expand Down
8 changes: 4 additions & 4 deletions provisioning/dashboards/dashboard2_GrafanaVariables.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down
12 changes: 6 additions & 6 deletions provisioning/dashboards/dashboard3_RandomWalk.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down
2 changes: 1 addition & 1 deletion src/components/DebuggingEditor.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand Down
4 changes: 2 additions & 2 deletions src/module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export const plugin = new PanelPlugin<FlowOptions>(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,
Expand All @@ -23,7 +23,7 @@ export const plugin = new PanelPlugin<FlowOptions>(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,
Expand Down

0 comments on commit da43d5a

Please sign in to comment.