Skip to content

Commit

Permalink
Merge pull request #2 from neo-technology/feature/rebase-2.2.3-release
Browse files Browse the repository at this point in the history
Rebase 2.2.3 release
  • Loading branch information
nielsdejong authored Feb 7, 2023
2 parents 8bec4b0 + 8dad9dc commit d8fa714
Show file tree
Hide file tree
Showing 86 changed files with 6,972 additions and 2,955 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ RUN chown -R nginx:nginx /usr/share/nginx/html/
USER nginx
EXPOSE 5005
HEALTHCHECK cmd curl --fail http://localhost:5005 || exit 1
LABEL version="2.2.1-pro-who"
LABEL version="2.2.3-extended-who"
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Reach out to us before distributing this code / the builds generated by this rep
## Setup
To configure this fork to get changes from the latest open-source repository:
```
git remote add upstream git@github.com:neo4j-labs/neodash.git
git remote add upstream git@github.com:neo4j-field/neodash-pro.git
git remote set-url --push upstream DISABLE
```

Expand Down
26 changes: 26 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,29 @@
## NeoDash 2.2.3
This releases fixes a small set of bugs that slipped through the 2.2.3 release, and adds some minor features:
- Added support for scatter plots by overriding a parameter in the line chart.
- Added the ability to use dashboard parameter as filters in custom parameter selector queries.
- Fixed breaking bug in parameter selector settings causing a white-screen error.
- Fixed auto-coloring of bar charts (resolved back to logic of 2.2.1 and earlier).
- Added a quick fix for automatically resetting the parameter display value when the property display override is toggled.
- Upversioned outdated dashboards and in the NeoDash Gallery.


## NeoDash 2.2.2
The NeoDash 2.2.2 release is packed with a bunch of new usability features:
- Changed the built-in Cypher editor to a brand-new [CodeMirror Editor](https://github.com/neo4j-contrib/cypher-editor).
- Rebuilt the **Parameter Select** component from scratch for improved stability, performance and extendability:
- Added an optional setting to the parameter selector to display a different property from the one that is set by the selector.
- Use this to - for example - let users choose a name and set an ID for use by other reports.
- Fields no longer reset randomly when parameters are changed.
- Freetext fields are no longer slow - perform as fast as the other selectors.
- Add the option to use rule-based styling based on dashboard parameters.
- Changed rule-based styling on bar and pie charts to override color scheme instead of clear the scheme.
- Extended the [Example Gallery](https://neodash-gallery.graphapp.io/) with several new demos.
- Adding intermediate report error boundaries for improved app stability.
- Changed docker image name to `neo4jlabs/neodash`.
- Improved documementation for developers.
- Fixed inconsistent styling between different pop-up screens, and fixed report title placeholders.

## NeoDash 2.2.1
This update provides a number of usability improves over the 2.2.0 release.
In addition, it entails various improvements to the codebase, including security patches on the dependencies.
Expand Down
2 changes: 1 addition & 1 deletion cypress/fixtures/cypher_queries.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 6 additions & 1 deletion cypress/integration/start_page.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ describe('NeoDash E2E Tests', () => {
cy.get('#dbpassword').type('test');
cy.wait(100);
cy.get('button').contains('Connect').click();
cy.wait(100);
});

it('initializes the dashboard', () => {
Expand Down Expand Up @@ -134,7 +135,11 @@ describe('NeoDash E2E Tests', () => {

it('creates a single value report', () => {
createReportOfType('Single Value', barChartCypherQuery);
cy.get('main .react-grid-item:eq(2) .MuiCardContent-root > div > div:nth-child(2) > span').contains('1,999');
cy.get('main .react-grid-item:eq(2) .MuiCardContent-root > div > div:nth-child(2) > span')
.invoke('text')
.then((text) => {
expect(text).to.be.oneOf(['1999', '1,999']);
});
});

it('creates a gauge chart report', () => {
Expand Down
2 changes: 1 addition & 1 deletion docs/antora.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: neodash
version: 2.2
title: NeoDash Documentation
title: NeoDash
start_page: ROOT:index.adoc
nav:
- modules/ROOT/nav.adoc
Expand Down
1 change: 1 addition & 0 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
** xref:user-guide/faq.adoc[FAQ]
* xref:developer-guide/index.adoc[Developer Guide]
** xref:developer-guide/build-and-run.adoc[Build & Run]
** xref:developer-guide/deploy-a-build.adoc[Deploy a Build]
** xref:developer-guide/configuration.adoc[Configuration]
** xref:developer-guide/standalone-mode.adoc[Standalone Mode]
** xref:developer-guide/component-overview.adoc[Component Overview]
Expand Down
12 changes: 6 additions & 6 deletions docs/modules/ROOT/pages/developer-guide/build-and-run.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ ____

To run the application in development mode:

- clone this repository.
- https://github.com/neo4j-labs/neodash[clone this repository.]
- open a terminal and navigate to the directory you just cloned.
- run `yarn install` to install the necessary dependencies.
- run `yarn run dev` to run the app in development mode.
Expand All @@ -33,8 +33,8 @@ Pull the latest image from Docker Hub to run the application locally:

....
# Run the application on http://localhost:5005
docker pull nielsdejong/neodash:latest
docker run -it --rm -p 5005:5005 nielsdejong/neodash
docker pull neo4jlabs/neodash:latest
docker run -it --rm -p 5005:5005 neo4jlabs/neodash
....

____
Expand All @@ -44,7 +44,7 @@ ____
== Build Docker image

A pre-built Docker image is available
https://hub.docker.com/r/nielsdejong/neodash[on DockerHub]. This image
https://hub.docker.com/r/neo4jlabs/neodash[on DockerHub]. This image
is built using the default configuration (running in editor mode,
without SSO).

Expand Down Expand Up @@ -84,7 +84,7 @@ metadata:
spec:
containers:
- name: neodash
image: nielsdejong/neodash:latest
image: neo4jlabs/neodash:latest
ports:
- containerPort: 5005
....
Expand All @@ -103,4 +103,4 @@ spec:
targetPort: 5005
selector:
project: neodash
....
....
41 changes: 41 additions & 0 deletions docs/modules/ROOT/pages/developer-guide/deploy-a-build.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
= 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.

This guide walks you through the process of deploying a NeoDash build onto your own webserver.

== 1. Prepare the files
First, check that you have the correct files.
We typically provide builds as either a zip file or tarball with the following naming convention:
`neodash-2.X.X.zip` or `neodash-2.X.X.tar.gz`.

For zip files, open up the terminal and run:
```bash
unzip neodash-2.X.X.zip
```

For tar.gz files, open up the terminal and run:
```bash
tar -xf neodash-2.X.X.tar.gz
```

After running either of these, you should now have a folder `neodash-2.X.X` in the current directory.

== 2. Edit Configuration (Optional)
This is an optional step if you want to configure optional settings for your NeoDash deployment (e.g. SSO or standalone mode).

1. Inside the folder you just unzipped, open up `config.json`.
2. Edit this file to modify your link:../configuration[Configuration] settings.
3. Save the file.

== 3. Move the tarball/zip to your webserver
Finally, copy the files to the correct folder on your webserver.
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.2.3 username@host:/usr/share/nginx/html
```

NeoDash should now be visible by visiting your (sub)domain in the browser.
Can't see the application? Check that the webserver user has read-permissions on the files you copied into the HTML directory.
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ docker run -it --rm -p 5005:5005 \
-e standaloneDatabase="neo4j" \
-e standaloneDashboardName="My Dashboard" \
-e standaloneDashboardDatabase="dashboards" \
nielsdejong/neodash
neo4jlabs/neodash
....

Make sure that all of the environment variables are set to the correct
Expand Down
4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/quickstart.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ https://neodash.graphapp.io.
App Gallery].
. Using Docker:
```
docker pull nielsdejong/neodash:latest
docker run -it --rm -p 5005:5005 nielsdejong/neodash
docker pull neo4jlabs/neodash:latest
docker run -it --rm -p 5005:5005 neo4jlabs/neodash
```

Or, build it yourself:
Expand Down
3 changes: 3 additions & 0 deletions docs/modules/ROOT/pages/user-guide/reports/choropleth.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ the visualization.
|Margin Bottom (px) |number |40 |The margin in pixels on the bottom side
of the visualization.

|Country Code Format |List |iso_a3 |ISO Standard used on country codes.


|Projection Scale |number |100 |Projection Scale of the visualization

|Projection x translation |number |0.5 |This parameter will move the center of
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/ROOT/pages/user-guide/reports/line-chart.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ image::line2.png[Multi Line Chart]
[width="100%",cols="13%,2%,6%,79%",options="header",]
|===
|Name |Type |Default Value |Description
|Plot Type |List |line | Whether to use a line plot (with connections) or a scatter plot of disjointed points

|Show Legend |on/off |off |If enabled, shows a legend at the top right
of the visualization.

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/user-guide/reports/map.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ relationship property to map to the arrow width. This lets you define
widths on a relationship-specific level, if you have a property that
directly maps to the width value.

|Map Provider URL|Text|https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png| When specified, overrides Open Street map provider with a custom map tiles provider.
|Map Provider URL|Text|https://\{s}.tile.openstreetmap.org/\{z}/\{x}/\{y}.png| When specified, overrides Open Street map provider with a custom map tiles provider.

|Intensity Property (for heatmap)|Text|intensity|Optionally, and only for heatmaps, the node property to use as the intensity of that point on the heatmap. If left empty, all points will have the same intensity of 1. If one of the nodes in the results doesn't have the specific property, its intensity will be set to 0.

Expand Down
2 changes: 2 additions & 0 deletions docs/modules/ROOT/pages/user-guide/reports/table.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ image::table2.png[Table with nodes / collections]
rows and columns of the table. This means that each of the returned rows
from Neo4j will be shown as a column instead of a row.

|Compact Table |on/off |off |When activated, makes the rows half height and increase the number of rows per page accordingly.

|Relative Column Sizes |List of numbers |[1, 1, 1, …] |The relative
width between each of the columns in the table. For example, if the
first column should be twice the width of the 2nd and 3rd, this will be
Expand Down
24 changes: 12 additions & 12 deletions docs/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/preview.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
site:
title: NeoDash Documentation
title: NeoDash

content:
sources:
Expand Down
Loading

0 comments on commit d8fa714

Please sign in to comment.