Skip to content

Commit b074fbe

Browse files
authored
docs: Remove stale and outdated content from the docs (#2366)
1 parent 9323ac0 commit b074fbe

27 files changed

Lines changed: 48 additions & 94 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The nodes provided integrate seamlessly with any of the existing nodes and flows
4242
<em style="display: block; text-align: center;">Example of data visualisations in FlowFuse Dashboard</em>
4343
</div>
4444

45-
No dashboard is complete without data visualisation. FlowFuse Dashboard provides a core `ui-chart` widget to provide a simple, yet powerful way to visualise your data. It supports a wide range of chart types, including line, bar and scatter, with more planned for the near future.
45+
No dashboard is complete without data visualisation. FlowFuse Dashboard provides a core `ui-chart` widget to provide a simple, yet powerful way to visualise your data. It supports line, area, bar, scatter, pie, doughnut and histogram charts.
4646

4747
### Flexible Customisation
4848

@@ -63,28 +63,19 @@ If you're looking to build your own bespoke templates, checkout our useful [UI T
6363

6464
### Build with Markdown & Mermaid
6565

66-
The new `ui-markdown` widget allows you to build rich, interactive applications using [Markdown](https://www.markdownguide.org/) and [Mermaid Charts](https://mermaid.js.org/). You can use Markdown templates to build your UI, and populate it with your own, dynamic data, and then use Mermaid to display dynamic charts and diagrams.
66+
The `ui-markdown` widget allows you to build rich, interactive applications using [Markdown](https://www.markdownguide.org/) and [Mermaid Charts](https://mermaid.js.org/). You can use Markdown templates to build your UI, and populate it with your own, dynamic data, and then use Mermaid to display dynamic charts and diagrams.
6767

68-
## Project Planning
68+
## Community and Contribution
6969

70-
### Community and Contribution
71-
72-
As an open-source project, FlowFuse Dashboard openly welcomes all forms of contributions, whether those are ideas, bug reports, or code contributions through Pull Requests.
70+
As an open-source project, FlowFuse Dashboard openly welcomes all forms of contributions, whether those are ideas, bug reports, or code contributions through Pull Requests.
7371

7472
We strongly believe in the power of community. If you have suggestions, feedback, or features you'd like to see, please open a [GitHub issue](https://github.com/FlowFuse/node-red-dashboard/issues/new/choose). We also highly encourage open-source contributions.
7573

76-
### Roadmap
77-
78-
We are constantly reviewing the priority of our backlog, and have multiple public project management boards where you can keep an eye on what we're working on, and what's coming up next:
79-
80-
- [Activity Tracker](https://github.com/orgs/FlowFuse/projects/15/views/1): See what's being actively worked on, what's up next, and if there are any "Blocked" items you could help with.
81-
- [Node-RED Dashboard Feature Parity](https://github.com/orgs/FlowFuse/projects/15/views/5): We haven't quite yet achieved 100% feature parity with the original Node-RED Dashboard, and this board tracks the progress and priority of those features.
82-
8374
## Motivation
8475

8576
The original [Node-RED Dashboard](https://github.com/node-red/node-red-dashboard) has served us well for many years, providing an intuitive way to create live dashboards for Node-RED flows. However, the original Dashboard is based on Angular v1, which is no longer actively maintained. We identified the need for a secure, updated, and innovative successor.
8677

87-
FlowFuse Dashboard was re-built from the ground up, learning from the popular features and feedback of Node-RED Dashboard. It will carry the legacy forward, adapting to future needs while keeping the essence of open-source and community-driven development intact. The project will is licensed under Apache 2.0.
78+
FlowFuse Dashboard was re-built from the ground up, learning from the popular features and feedback of Node-RED Dashboard. It will carry the legacy forward, adapting to future needs while keeping the essence of open-source and community-driven development intact. The project is licensed under Apache 2.0.
8879

8980
## Release process
9081

‎docs/.vitepress/theme/Layout.vue‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,9 @@
11
<script setup>
2-
import AdvertBanner from '../../components/AdvertBanner.vue';
32
import DefaultTheme from 'vitepress/theme'
43
54
const { Layout } = DefaultTheme
65
</script>
76

87
<template>
9-
<Layout>
10-
<template #layout-top>
11-
<AdvertBanner href="https://events.zoom.us/ev/Ag_xPefs5sgZrJ1NFahdYqv-WfvhdtzQOkVaQMrJcPZQilHl_XXW~AjQ-n6IUY0fUjVBbmBQPTNH9vaRjeuW6FTyjvypb8lqTF7JyYP3j_qJdQHx8jU-idBH-cpxCCfQ1dT8_beCAsxpGPA">
12-
<b>Node-RED Con 2026 – Nov. 3:</b> Node-RED at the Edge of Intelligence — <span class="underline">Register free today!</span>
13-
</AdvertBanner>
14-
</template>
15-
</Layout>
16-
</template>
8+
<Layout />
9+
</template>

‎docs/de/contributing/guides/events.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,4 +165,4 @@ Innerhalb der `ui-config` ist die `widgets`-Eigenschaft ein Array von `Widget`-O
165165
- **id**: Die von Node-RED zugewiesene ID, um diesen Knoten im Editor eindeutig zu identifizieren
166166
- **props**: Die Sammlung von Eigenschaften, die der Benutzer im Editor für diesen Knoten definieren kann
167167
- **component** - Die jeweilige Vue-Komponente, die für das Rendering erforderlich ist, hinzugefügt im Frontend (in App.vue)
168-
- **state** - Enthält Werte, die den visuellen und interaktiven "Zustand" eines Widgets definieren, z.B. `enabled: true` oder `visible: false` (`visible:` wird noch nicht unterstützt)
168+
- **state** - Enthält Werte, die den visuellen und interaktiven "Zustand" eines Widgets definieren, z.B. `enabled: true` oder `visible: false`

‎docs/de/contributing/guides/layouts.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Die Navigationshierarchie der Dashboard-Benutzeroberfläche ist wie folgt:
1818

1919
`/Layouts/Baseline.vue` definiert die Grundstruktur einer Seite (Header und linke Navigationsleiste). Andere Layouts können dann diese Basis erweitern und definieren, _wie_ die Widgets innerhalb des Standard-`<slot></slot>` der Basis gerendert werden.
2020

21-
Diese Liste von Basislayouts wird wahrscheinlich im Laufe der Zeit wachsen und umfasst derzeit nur eine _sehr_ einfache Startervorlage (Seitenleiste und Header).
21+
Derzeit gibt es nur ein Basislayout, eine _sehr_ einfache Startervorlage (Seitenleiste und Header).
2222

2323
## Hinzufügen eines neuen Layout-Managers
2424

‎docs/de/contributing/widgets/debugging.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ _Screenshot des Dashboard 2.0 Debugging-Tools_
1313

1414
Dieses Tool ist besonders nützlich, wenn Sie Ihre eigenen benutzerdefinierten Integrationen erstellen und auch an den Kern-Dashboard-Widgets entwickeln.
1515

16-
Wir hoffen, den Umfang dessen, was dieses Tool bietet, zu erweitern, aber vorerst zeigt es die aktuellen `props` für ein gegebenes Widget an, die durch die Node-RED-Konfiguration definiert sind, aber auch die überschriebenen Werte aus dem `msg`-Objekt enthalten (z.B. kann `msg.options` die `Options`-Eigenschaft für ein `ui-dropdown` überschreiben).
16+
Es zeigt die aktuellen `props` für ein gegebenes Widget an, die durch die Node-RED-Konfiguration definiert sind, aber auch die überschriebenen Werte aus dem `msg`-Objekt enthalten (z.B. kann `msg.options` die `Options`-Eigenschaft für ein `ui-dropdown` überschreiben).
1717

1818
## Nachrichtenverlauf
1919

‎docs/de/layouts/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@ Eine zusätzliche Option, die auf Gruppenbasis verfügbar ist, ist, ob der Name
6060

6161
Obwohl wir angemessene Anpassungsstufen bieten, gibt es einige Bereiche, die derzeit nicht konfigurierbar sind:
6262

63-
- **Zeilenhöhe:** Eine einzelne Einheit der Höhe ist derzeit auf 48px festgelegt. Dies kann derzeit nicht geändert werden. Dies betrifft auch das "Feste" Layout, bei dem eine einzelne Einheit der Breite durch diesen Wert bestimmt wird.
63+
- **Zeilenhöhe:** Eine einzelne Einheit der Höhe wird durch die Option "Zeilenhöhe" des Themes festgelegt (standardmäßig 48px). Dies betrifft auch das "Feste" Layout, bei dem eine einzelne Einheit der Breite durch diesen Wert bestimmt wird.
6464
- **Gruppenabstand:** Der Abstand, der den gesamten Inhalt der Gruppe umschließt, oben als <span style="color: blue;">blauer</span> Raum dargestellt.

‎docs/de/layouts/types/fixed.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,9 @@ description: Erfahren Sie, wie Sie das feste Layout im Node-RED Dashboard 2.0 f
44

55
# Layout: Fest
66

7-
_Hinweis: Dieses Layout benötigt noch Arbeit, um es flexibler und praktischer zu machen. Es wird empfohlen, vorerst ein anderes Layout zu verwenden._
8-
97
Jede "Einheit" hat eine feste Breite, was das einzige verfügbare Layout im Dashboard 1.0 war.
108

11-
Es ist als Flexbox-Layout aufgebaut, mit einer einzigen Reihe von Widgets. Die Breite jeder Gruppe ist eine feste Pixelgröße, berechnet als die "Breite"-Eigenschaft einer Gruppe, multipliziert mit 90px (wobei unsere Standardzeilenhöhe 45px beträgt).
9+
Es ist als Flexbox-Layout aufgebaut, mit einer einzigen Reihe von Widgets. Die Breite jeder Gruppe ist eine feste Pixelgröße, berechnet als die "Breite"-Eigenschaft einer Gruppe, multipliziert mit der doppelten Zeilenhöhe (96px bei der Standardzeilenhöhe von 48px).
1210

1311
Die Gruppen selbst folgen demselben Muster wie alle anderen Layouts, wobei eine Gruppe mit der Breite "6" 6 "Spalten" hätte, mit entsprechend dimensionierten Widgets, sodass ein Widget der Größe "3 x 1" 50% der Gruppenbreite einnehmen würde.
1412

‎docs/de/nodes/widgets.md‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -149,9 +149,3 @@ Hier ist eine Liste der Drittanbieter-Widgets, von denen wir wissen, um es Ihnen
149149
- [@omrid01/table-tabulator](https://flows.nodered.org/node/@omrid01/node-red-dashboard-2-table-tabulator): Bietet ein reichhaltiges Tabellen-Widget für das Dashboard, das die beliebte [Tabulator](http://tabulator.info/) JavaScript-Bibliothek erweitert.
150150
- [@revolutionpi/hmi](https://flows.nodered.org/node/@revolutionpi/node-red-dashboard-2-hmi): Ein anpassbarer runder Button, der nach industriellen HMI-Drucktasten gestaltet ist.
151151
- [@cgjgh/ui-scheduler](https://flows.nodered.org/node/@cgjgh/node-red-dashboard-2-ui-scheduler): Ein Planer-Widget für die UI-basierte Zeitplanverwaltung.
152-
153-
### In Entwicklung
154-
155-
Die folgenden sind eine Liste von Knoten, von denen wir wissen, dass sie in aktiver Entwicklung sind, aber noch nicht im Node-RED Palette Manager veröffentlicht wurden.
156-
157-
- [@bartbutenaers/ui-svg](https://github.com/bartbutenaers/node-red-dashboard-2-ui-svg/tree/master): Fügt Ihrem Dashboard ein SVG-Widget hinzu, mit dynamischen Steuerungen über das Plotten und Styling.

‎docs/de/nodes/widgets/ui-file-input.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Das Datei-Upload-Widget ermöglicht es Benutzern, Dateien zu Node-RED hochzulade
4646

4747
## Aktuelle Einschränkungen
4848

49-
_Derzeit_ ist das Datei-Upload-Widget durch eine maximale Dateigröße begrenzt, die durch die Websocket-Verbindung definiert wird. Der Standardwert hier beträgt 5 MB. Dies kann erhöht werden, indem die `maxHttpBufferSize`-Eigenschaft in der `settings.js`-Datei im Node-RED-Installationsverzeichnis geändert wird:
49+
Das Datei-Upload-Widget ist durch eine maximale Dateigröße begrenzt, die durch die Websocket-Verbindung definiert wird. Der Standardwert hier beträgt 5 MB. Dies kann erhöht werden, indem die `maxHttpBufferSize`-Eigenschaft in der `settings.js`-Datei im Node-RED-Installationsverzeichnis geändert wird:
5050

5151
```
5252
dashboard: {
@@ -56,8 +56,6 @@ dashboard: {
5656

5757
Lesen Sie mehr über die Dashboard-Konfiguration in der `settings.js` [hier](/de/user/settings.html#maxhttpbuffersize).
5858

59-
Beachten Sie, dass wir planen, dieses Verhalten zu verbessern, indem wir Dateien in kleinere Teile aufteilen und sie auf der Serverseite wieder zusammensetzen. Dies wird es ermöglichen, größere Dateien hochzuladen und wird in einer zukünftigen Version implementiert.
60-
6159
## Beispiel
6260

6361
![Beispiel eines Datei-Uploads](/images/node-examples/ui-file-input-select.png "Beispiel eines Datei-Uploads"){data-zoomable}

‎docs/de/user/migration.md‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -222,8 +222,6 @@ Wir haben versucht, das Thema in Dashboard 2.0 benutzerfreundlicher zu gestalten
222222
![Beispiel für das Bearbeiten eines Themas](/images/theme-config.png "Beispiel für das Bearbeiten eines Themas"){data-zoomable}
223223
_Beispiel der im Node-RED Editor freigelegten Eigenschaften beim Definieren eines Themas_
224224

225-
Wir haben Pläne, diese Themenkonfiguration weiter auszubauen, sodass Sie auch Rasterabstände, Schriftarten usw. definieren können.
226-
227225
Jede weitere Anpassung des gesamten Layouts und Themas des Dashboards erfordert benutzerdefiniertes CSS, das über den `ui_template`-Knoten injiziert werden kann.
228226

229227
## Layouts
@@ -232,17 +230,16 @@ Dashboard 2.0 folgt einer ähnlichen Architektur wie Dashboard 1.0 zur Verwaltun
232230

233231
| Dashboard 1.0 | Dashboard 2.0 | Unterschied |
234232
| --- | --- | --- |
235-
| `ui-base` | `ui-base` | Wir haben dies als Konfigurationsknoten in Dashboard 2.0 freigelegt, wo eine `ui-page` einem übergeordneten `ui-base` zugewiesen wird. Obwohl noch nicht unterstützt, möchten wir schließlich _mehrere_ Basis-Dashboards in derselben Node-RED-Instanz unterstützen. |
233+
| `ui-base` | `ui-base` | Wir haben dies als Konfigurationsknoten in Dashboard 2.0 freigelegt, wo eine `ui-page` einem übergeordneten `ui-base` zugewiesen wird. Pro Node-RED-Instanz wird nur ein `ui-base` unterstützt. |
236234
| `ui-tab` | `ui-page` | Zusätzlich zu einer Umbenennung hier haben wir auch die Unterstützung für eine `ui-page` hinzugefügt, um ein definiertes "Thema" zu haben (gesteuert durch unsere neuen `ui-theme`-Konfigurationsknoten). Jede `ui-page` hat auch eine neue _"Layout"_ Option, die seitenweise eingestellt werden kann. |
237235
| `ui-group` | `ui-group` | Derzeit kein "Zusammenklappen"-Verhalten, aber andere Funktionalität ist gleich. |
238236

239-
Wir haben derzeit drei Layouts in Dashboard 2.0 verfügbar:
237+
Wir haben derzeit vier Layouts in Dashboard 2.0 verfügbar:
240238

241239
- [**Raster**](../layouts/types/grid.md) - Modelliert mit dem CSS-`grid`-Layout, ist dies das Standardlayout und verwendet einen festen 12-Spalten-Ansatz, bei dem der Inhalt horizontal mit der Bildschirmbreite skaliert wird, was es viel freundlicher für reaktionsfähige Layouts macht.
242-
- [**Fest**](../layouts/types/fixed.md) - Dies verwendet ein CSS-Flex-Layout und ist das ähnlichste, was wir derzeit zum einzigen Layout in Dashboard 1.0 haben. Verbesserungen sind hier erforderlich, um die "Pack"-Natur des Layouts zu verbessern.
240+
- [**Fest**](../layouts/types/fixed.md) - Dies verwendet ein CSS-Flex-Layout und ist das ähnlichste, was wir derzeit zum einzigen Layout in Dashboard 1.0 haben.
243241
- [**Notizbuch**](../layouts/types/notebook.md) - Nachahmung eines Jupyter-Notizbuch-Layouts, bietet dies Inhalte mit einer maximalen Breite, skaliert mit mobilen Geräten und ermöglicht es, Inhalte vertikal zu stapeln.
244-
245-
Wir haben auch zukünftige Pläne, die Injektion von Drittanbieter-Layouts und sogar clientseitig bearbeitbare Layouts (z.B. Drag-and-Drop-Layout-Design) zu unterstützen.
242+
- [**Tabs**](../layouts/types/tabs.md) - Rendert die Gruppen einer Seite in einer Registerkartenansicht, mit einer oder mehreren Gruppen pro Tab.
246243

247244
## Drittanbieter-Widgets
248245

0 commit comments

Comments
 (0)