Merge pull request #967 from neo4j-labs/feature/new-readme-evolving

Added evolution notice & bump version to 2.4.9
neo4j-labs · Nov 14, 2024 · 07dc37e · 07dc37e
2 parents aeb1cd0 + c95013c
commit 07dc37e
Show file tree

Hide file tree

Showing 62 changed files with 172 additions and 22 deletions.
diff --git a/.github/workflows/master-deployment.yml b/.github/workflows/master-deployment.yml
@@ -79,7 +79,7 @@ jobs:
           context: .
           file: ./Dockerfile
           push: true
-          tags: ${{ secrets.DOCKER_HUB_LABS_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_LABS_USERNAME }}/neodash:2.4.8
+          tags: ${{ secrets.DOCKER_HUB_LABS_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_LABS_USERNAME }}/neodash:2.4.9
   build-docker-legacy:
     needs: build-test
     runs-on: neodash-runners
@@ -103,7 +103,7 @@ jobs:
           context: .
           file: ./Dockerfile
           push: true
-          tags: ${{ secrets.DOCKER_HUB_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_USERNAME }}/neodash:2.4.8
+          tags: ${{ secrets.DOCKER_HUB_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_USERNAME }}/neodash:2.4.9
   deploy-gallery:
     runs-on: neodash-runners
     strategy:

diff --git a/Dockerfile b/Dockerfile
@@ -44,4 +44,4 @@ USER nginx
 EXPOSE $NGINX_PORT
 
 HEALTHCHECK cmd curl --fail "http://localhost:$NGINX_PORT" || exit 1
-LABEL version="2.4.8"
+LABEL version="2.4.9"
diff --git a/README.md b/README.md
@@ -1,16 +1,24 @@
 
-## NeoDash - Neo4j Dashboard Builder
-NeoDash is an open source tool for visualizing your Neo4j data. It lets you group visualizations together as dashboards, and allow for interactions between reports.
+## NeoDash Labs - Neo4j Dashboard Builder
 
-![screenshot](public/screenshot.png)
+![screenshot](evolving.png)
+
+In September 2024 **Neo4j [announced](https://www.datanami.com/2024/09/04/neo4j-simplifies-graph-database-in-the-cloud/#:~:text=NeoDash%20is%20an%20open%20source,was%20open%20source%2C%20not%20supported) NeoDash is evolving into a fully supported dashboard builder, as part of the Neo4j product suite**. 
+
+This project (NeoDash Labs) will still be available and contain experimental features, but will **not** have official support. If you're interested to get official support for NeoDash as part of a Neo4j License agreement, please reach out to your Neo4j contact person.
+
+## About NeoDash Labs
+NeoDash is a web-based tool for visualizing your Neo4j data. It lets you group visualizations together as dashboards, and allow for interactions between reports.
 
 Neodash supports presenting your data as tables, graphs, bar charts, line charts, maps and more. It contains a Cypher editor to directly write the Cypher queries that populate the reports. You can save dashboards to your database, and share them with others.
 
-## Try NeoDash
+## Try NeoDash Labs
 You can run NeoDash in one of three ways:
 
-1. You can install NeoDash into Neo4j Desktop from the [graph app gallery](https://install.graphapp.io). NeoDash will automatically connect to your active database.
-2. You can run NeoDash from a web browser by visiting http://neodash.graphapp.io.
+1. You can install NeoDash Labs into Neo4j Desktop from the [graph app gallery](https://install.graphapp.io). NeoDash will automatically connect to your active database.
+> Note: never versions of Neo4j Desktop do not support adding experimental graph apps such as NeoDash.
+
+2. You can run NeoDash Labs from a web browser by visiting http://neodash.graphapp.io.
 3. For on-prem deployments, you can build the application yourself, or pull the latest Docker image from Docker Hub.
 ```
 # Run the application on http://localhost:5005
@@ -79,4 +87,4 @@ If you have any questions about NeoDash, please reach out to the maintainers:
 - Connect with us on the [Neo4j Discord](https://neo4j.com/developer/discord/).
 - Create a post on the Neo4j [Community Forum](https://community.neo4j.com/).
 
-> NeoDash is a free and open-source tool developed by the Neo4j community - not an official Neo4j product. If you have a need for a commercial agreement around training, custom extensions or other services, please contact the [Neo4j Professional Services](https://neo4j.com/professional-services/) team.
+> NeoDash Labs is a free and open-source tool developed by the Neo4j community - not an official Neo4j product. Use at your own risk!
diff --git a/changelog.md b/changelog.md
@@ -1,3 +1,23 @@
+## NeoDash 2.4.9
+This release adds some minor changes to documentation and implements some community contributions.
+- Added notice about project evolution: [#967](https://github.com/neo4j-labs/neodash/pull/967)
+- Added community contributions and bug fixes: 
+[#967](https://github.com/neo4j-labs/neodash/pull/967)
+[#894](https://github.com/neo4j-labs/neodash/pull/894)
+[#822](https://github.com/neo4j-labs/neodash/pull/822)
+[#951](https://github.com/neo4j-labs/neodash/pull/951)
+[#946](https://github.com/neo4j-labs/neodash/pull/946)
+[#944](https://github.com/neo4j-labs/neodash/pull/944)
+[#943](https://github.com/neo4j-labs/neodash/pull/943)
+[#938](https://github.com/neo4j-labs/neodash/pull/938)
+[#935](https://github.com/neo4j-labs/neodash/pull/935)
+[#918](https://github.com/neo4j-labs/neodash/pull/918)
+[#908](https://github.com/neo4j-labs/neodash/pull/908)
+[#906](https://github.com/neo4j-labs/neodash/pull/906)
+[#902](https://github.com/neo4j-labs/neodash/pull/902)
+[#895](https://github.com/neo4j-labs/neodash/pull/895)
+[#893](https://github.com/neo4j-labs/neodash/pull/893)
+
 ## NeoDash 2.4.8
 This is a minor release containing an important fix and other minor fixes:
 

diff --git a/docs/modules/ROOT/pages/banner.adoc b/docs/modules/ROOT/pages/banner.adoc
@@ -0,0 +1,6 @@
+[NOTE]
+====
+This documentation pertains to the unsupported version of NeoDash, as part of Neo4j Labs.
+For users of the supported NeoDash offering, refer to https://neo4j.com/docs/neodash-commercial/[NeoDash commercial].
+
+====
diff --git a/docs/modules/ROOT/pages/developer-guide/adding-visualizations.adoc b/docs/modules/ROOT/pages/developer-guide/adding-visualizations.adoc
@@ -1,3 +1,5 @@
+include::../banner.adoc[]
+
 = Adding Visualizations
 
 You can extend NeoDash with your own visualizations without diving deep

diff --git a/docs/modules/ROOT/pages/developer-guide/build-and-run.adoc b/docs/modules/ROOT/pages/developer-guide/build-and-run.adoc
@@ -1,3 +1,5 @@
+include::../banner.adoc[]
+
 = Build & Run
 
 To start developing the application, you will need to set up the

diff --git a/docs/modules/ROOT/pages/developer-guide/component-overview.adoc b/docs/modules/ROOT/pages/developer-guide/component-overview.adoc
@@ -1,3 +1,5 @@
+include::../banner.adoc[]
+
 = Component Overview
 
 

diff --git a/docs/modules/ROOT/pages/developer-guide/configuration.adoc b/docs/modules/ROOT/pages/developer-guide/configuration.adoc
@@ -1,3 +1,5 @@
+include::../banner.adoc[]
+
 = Configuration
 
 When using a custom NeoDash deployment, there are several settings that

diff --git a/docs/modules/ROOT/pages/developer-guide/contributing.adoc b/docs/modules/ROOT/pages/developer-guide/contributing.adoc
@@ -1,3 +1,5 @@
+include::../banner.adoc[]
+
 = Contributing
 
 Contributions to the project are highly welcomed. Please consider

diff --git a/docs/modules/ROOT/pages/developer-guide/deploy-a-build.adoc b/docs/modules/ROOT/pages/developer-guide/deploy-a-build.adoc
@@ -1,3 +1,5 @@
+include::../banner.adoc[]
+
 = Deploy a Build
 If you have a pre-built NeoDash application, you can easily deploy it on an any webserver.
 A NeoDash build is "just" a collection of HTML, CSS and JavaScript files, so it can run virtually anywhere.
@@ -37,7 +39,7 @@ Depending on the webserver type and version, this could be different directory.
 As an example - to copy the files to an nginx webserver using `scp`:
 
 ```bash
-scp neodash-2.4.8 username@host:/usr/share/nginx/html
+scp neodash-2.4.9-labs username@host:/usr/share/nginx/html
 ```
 
 NeoDash should now be visible by visiting your (sub)domain in the browser.

diff --git a/docs/modules/ROOT/pages/developer-guide/design.adoc b/docs/modules/ROOT/pages/developer-guide/design.adoc
@@ -1,3 +1,5 @@
+include::../banner.adoc[]
+
 = Design
 
 This page contains some key guidelines for design of the application.

diff --git a/docs/modules/ROOT/pages/developer-guide/index.adoc b/docs/modules/ROOT/pages/developer-guide/index.adoc
@@ -1,3 +1,5 @@
+include::../banner.adoc[]
+
 = Developer Guide
 
 This guide contains information for developers looking to deploy NeoDash, or extend it for their own needs. 

diff --git a/docs/modules/ROOT/pages/developer-guide/session-storage.adoc b/docs/modules/ROOT/pages/developer-guide/session-storage.adoc
@@ -1,3 +1,5 @@
+include::../banner.adoc[]
+
 = Session Storage
 
 This reducer serves only to store data that we want to reset at each new session.

diff --git a/docs/modules/ROOT/pages/developer-guide/standalone-mode.adoc b/docs/modules/ROOT/pages/developer-guide/standalone-mode.adoc
@@ -1,3 +1,5 @@
+include::../banner.adoc[]
+
 = Standalone Mode
 
 Next to being a dashboard editor, NeoDash can be deployed in a

diff --git a/docs/modules/ROOT/pages/developer-guide/state-management.adoc b/docs/modules/ROOT/pages/developer-guide/state-management.adoc
@@ -1,3 +1,5 @@
+include::../banner.adoc[]
+
 = State Management
 
 NeoDash is an application with a complex internal state. If you are

diff --git a/docs/modules/ROOT/pages/developer-guide/style-configuration.adoc b/docs/modules/ROOT/pages/developer-guide/style-configuration.adoc
@@ -1,3 +1,5 @@
+include::../banner.adoc[]
+
 = Style Configuration
 
 When using a custom NeoDash deployment, there are several theme variables that

diff --git a/docs/modules/ROOT/pages/developer-guide/testing.adoc b/docs/modules/ROOT/pages/developer-guide/testing.adoc
@@ -1,3 +1,5 @@
+include::../banner.adoc[]
+
 = Testing 
 
 NeoDash uses *Cypress* for automated testing. To install Cypress, check

diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
@@ -1,3 +1,5 @@
+include::/banner.adoc[]
+
 = Introduction
 This portal contains information on getting started with NeoDash - A Low-Code Dashboard Builder for Neo4j.
 

diff --git a/docs/modules/ROOT/pages/quickstart.adoc b/docs/modules/ROOT/pages/quickstart.adoc
@@ -1,3 +1,5 @@
+include::/banner.adoc[]
+
 = Quickstart
 
 There are three easy ways to run NeoDash and start dashboarding your Neo4j data:

diff --git a/docs/modules/ROOT/pages/user-guide/access-control.adoc b/docs/modules/ROOT/pages/user-guide/access-control.adoc
@@ -1,3 +1,5 @@
+include::../banner.adoc[]
+
 = Access Control
 
 The Access Control feature in NeoDash is a security measure that allows Users with write access or higher privileges to manage who has access to specific dashboards.

diff --git a/docs/modules/ROOT/pages/user-guide/bloom-integration.adoc b/docs/modules/ROOT/pages/user-guide/bloom-integration.adoc
@@ -1,3 +1,5 @@
+include::../banner.adoc[]
+
 = Bloom Integration
 
 NeoDash can be linked to Neo4j Bloom perspectives by using

diff --git a/docs/modules/ROOT/pages/user-guide/dashboards.adoc b/docs/modules/ROOT/pages/user-guide/dashboards.adoc
@@ -1,3 +1,5 @@
+include::../banner.adoc[]
+
 = Dashboards
 
 In NeoDash, a dashboard consists of several pages, each of which can

diff --git a/docs/modules/ROOT/pages/user-guide/extensions/access-control-management.adoc b/docs/modules/ROOT/pages/user-guide/extensions/access-control-management.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Access Control Management
 
 This extension lets you manage access control for roles and users, letting you assign users to roles as well as controlling which node labels can be read by a user.

diff --git a/docs/modules/ROOT/pages/user-guide/extensions/advanced-visualizations.adoc b/docs/modules/ROOT/pages/user-guide/extensions/advanced-visualizations.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Advanced Visualizations
 
 Advanced visualizations let you extend your dashboard with complex, powerful visualizations beyond the standard visualizations.

diff --git a/docs/modules/ROOT/pages/user-guide/extensions/forms.adoc b/docs/modules/ROOT/pages/user-guide/extensions/forms.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Forms
 
 The 'forms' extension lets you combine different parameter selectors to update / modify your graph data.

diff --git a/docs/modules/ROOT/pages/user-guide/extensions/index.adoc b/docs/modules/ROOT/pages/user-guide/extensions/index.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Extensions
 
 Extensions provide a way to expand the basic functionality of NeoDash with extra features.

diff --git a/docs/modules/ROOT/pages/user-guide/extensions/natural-language-queries.adoc b/docs/modules/ROOT/pages/user-guide/extensions/natural-language-queries.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Text2Cypher - Natural Language Queries
 Use natural language to generate Cypher queries in NeoDash. Connect to an LLM through an API, and let NeoDash use your database schema + the report types to generate queries automatically.
 

diff --git a/docs/modules/ROOT/pages/user-guide/extensions/report-actions.adoc b/docs/modules/ROOT/pages/user-guide/extensions/report-actions.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Report Actions 
 
 link:../#_2_pro_extensions[label:Pro&nbsp;Extension[]]

diff --git a/docs/modules/ROOT/pages/user-guide/extensions/rule-based-styling.adoc b/docs/modules/ROOT/pages/user-guide/extensions/rule-based-styling.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Rule-Based Styling 
 
 

diff --git a/docs/modules/ROOT/pages/user-guide/extensions/workflows.adoc b/docs/modules/ROOT/pages/user-guide/extensions/workflows.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Workflows
 
 Introducing an advanced extension for creating, managing, and running workflows with Cypher queries. Simplify ETL flows, execute complex query chains, and run graph data science workloads effortlessly from Neodash.

diff --git a/docs/modules/ROOT/pages/user-guide/faq.adoc b/docs/modules/ROOT/pages/user-guide/faq.adoc
@@ -1,3 +1,5 @@
+include::../banner.adoc[]
+
 = FAQ
 
 == 1. How can I learn more about NeoDash?

diff --git a/docs/modules/ROOT/pages/user-guide/index.adoc b/docs/modules/ROOT/pages/user-guide/index.adoc
@@ -1,3 +1,5 @@
+include::../banner.adoc[]
+
 = User Guide
 
 The following pages contain everything you need to get started with NeoDash.

diff --git a/docs/modules/ROOT/pages/user-guide/pages.adoc b/docs/modules/ROOT/pages/user-guide/pages.adoc
@@ -1,3 +1,5 @@
+include::../banner.adoc[]
+
 = Pages
 
 A page is a collection of link:../reports[reports] that can be viewed at

diff --git a/docs/modules/ROOT/pages/user-guide/publishing.adoc b/docs/modules/ROOT/pages/user-guide/publishing.adoc
@@ -1,3 +1,5 @@
+include::../banner.adoc[]
+
 = Publishing
 
 When you are done building a dashboard, you may want to *publish* that

diff --git a/docs/modules/ROOT/pages/user-guide/reports/areamap.adoc b/docs/modules/ROOT/pages/user-guide/reports/areamap.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Area Map
 
 link:../../extensions/advanced-visualizations[label:Advanced&nbsp;Visualization[]]

diff --git a/docs/modules/ROOT/pages/user-guide/reports/bar-chart.adoc b/docs/modules/ROOT/pages/user-guide/reports/bar-chart.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Bar Chart
 
 A bar chart will draw categories and values in a familiar bar-layout.

diff --git a/docs/modules/ROOT/pages/user-guide/reports/choropleth.adoc b/docs/modules/ROOT/pages/user-guide/reports/choropleth.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Choropleth
 
 link:../../extensions/advanced-visualizations[label:Advanced&nbsp;Visualization[]]

diff --git a/docs/modules/ROOT/pages/user-guide/reports/circle-packing.adoc b/docs/modules/ROOT/pages/user-guide/reports/circle-packing.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Circle Packing
 
 link:../../extensions/advanced-visualizations[label:Advanced&nbsp;Visualization[]]

diff --git a/docs/modules/ROOT/pages/user-guide/reports/form.adoc b/docs/modules/ROOT/pages/user-guide/reports/form.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Form
 
 A form is a special type of report that lets users run predefined, parameterized queries.

diff --git a/docs/modules/ROOT/pages/user-guide/reports/gantt.adoc b/docs/modules/ROOT/pages/user-guide/reports/gantt.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Gantt Chart
 
 link:../../extensions/advanced-visualizations[label:Advanced&nbsp;Visualization[]]

diff --git a/docs/modules/ROOT/pages/user-guide/reports/gauge-chart.adoc b/docs/modules/ROOT/pages/user-guide/reports/gauge-chart.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Gauge Chart
 
 link:../../extensions/advanced-visualizations[label:Advanced&nbsp;Visualization[]]

diff --git a/docs/modules/ROOT/pages/user-guide/reports/graph.adoc b/docs/modules/ROOT/pages/user-guide/reports/graph.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Graph
 
 The graph report will render all returned nodes, relationships and paths

diff --git a/docs/modules/ROOT/pages/user-guide/reports/graph3d.adoc b/docs/modules/ROOT/pages/user-guide/reports/graph3d.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = 3D Graph
 
 link:../../extensions/advanced-visualizations[label:Advanced&nbsp;Visualization[]]

diff --git a/docs/modules/ROOT/pages/user-guide/reports/iframe.adoc b/docs/modules/ROOT/pages/user-guide/reports/iframe.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = iFrame
 
 An iFrame report lets you embed a webpage inside your NeoDash dashboard.

diff --git a/docs/modules/ROOT/pages/user-guide/reports/index.adoc b/docs/modules/ROOT/pages/user-guide/reports/index.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Reports
 
 A report is the smallest building build of your dashboard. Each report

diff --git a/docs/modules/ROOT/pages/user-guide/reports/line-chart.adoc b/docs/modules/ROOT/pages/user-guide/reports/line-chart.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Line Chart
 
 A line chart can be used to draw one or more lines in a two-dimensional

diff --git a/docs/modules/ROOT/pages/user-guide/reports/map.adoc b/docs/modules/ROOT/pages/user-guide/reports/map.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Map
 
 The map report will render all returned nodes, relationships and paths

diff --git a/docs/modules/ROOT/pages/user-guide/reports/markdown.adoc b/docs/modules/ROOT/pages/user-guide/reports/markdown.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Markdown
 
 Markdown reports let you specify

diff --git a/docs/modules/ROOT/pages/user-guide/reports/parameter-select.adoc b/docs/modules/ROOT/pages/user-guide/reports/parameter-select.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Parameter Select
 Parameter select reports provide you with an easy way to add
 interactivity into your dashboards.

diff --git a/docs/modules/ROOT/pages/user-guide/reports/pie-chart.adoc b/docs/modules/ROOT/pages/user-guide/reports/pie-chart.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Pie Chart
 
 A pie chart will draw categories and values in a circular disc layout.

diff --git a/docs/modules/ROOT/pages/user-guide/reports/radar.adoc b/docs/modules/ROOT/pages/user-guide/reports/radar.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Radar Chart
 
 link:../../extensions/advanced-visualizations[label:Advanced&nbsp;Visualization[]]

diff --git a/docs/modules/ROOT/pages/user-guide/reports/raw-json.adoc b/docs/modules/ROOT/pages/user-guide/reports/raw-json.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Raw JSON
 
 The Raw JSON report renders the JSON response received from Neo4j

diff --git a/docs/modules/ROOT/pages/user-guide/reports/sankey.adoc b/docs/modules/ROOT/pages/user-guide/reports/sankey.adoc
@@ -1,3 +1,5 @@
+include::../../banner.adoc[]
+
 = Sankey Chart
 
 link:../../extensions/advanced-visualizations[label:Advanced&nbsp;Visualization[]]