Fix docs links, added release notes (#182)

* Bumping version * Updated references to new documentation portal * Fixed some more broken links. Added 2.1.3 release notes * Small fixes to release notes
neo4j-labs · nielsdejong · Aug 4, 2022 · Jun 21, 2022 · Jun 22, 2022 · Jun 22, 2022
commit d5c6f769d8d28a9d46bff58dbc4dddd3816bf426
diff --git a/.github/workflows/master-deployment.yml b/.github/workflows/master-deployment.yml
@@ -71,7 +71,7 @@ jobs:
       context: .
       file: ./Dockerfile
       push: true
-      tags: ${{ secrets.DOCKER_HUB_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_USERNAME }}/neodash:2.1.2
+      tags: ${{ secrets.DOCKER_HUB_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_USERNAME }}/neodash:2.1.3
  build-npm:
    needs: build-test
    runs-on: ubuntu-latest

diff --git a/Dockerfile b/Dockerfile
@@ -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.1.2"
+LABEL version="2.1.3"
diff --git a/README.md b/README.md
@@ -20,14 +20,14 @@ docker run -it --rm -p 5005:5005 nielsdejong/neodash
 
 > Windows users may need to prefix the `docker run` command with `winpty`.
 
-See the [Developer Guide](https://github.com/neo4j-labs/neodash/wiki/Developer%20Guide) for more on installing, building, and running the application.
+See the [Developer Guide](https://neo4j.com/labs/neodash/2.1/developer-guide/) for more on installing, building, and running the application.
 
 ## User Guide
 NeoDash comes with built-in examples of dashboards and reports. For more details on the types of reports and how to customize them, see the [User Guide](
-https://github.com/neo4j-labs/neodash/wiki/User-Guide).
+https://neo4j.com/labs/neodash/2.1/user-guide/).
 
 ## Publish Dashboards
-After building a dashboard, you can chose to deploy a read-only, standalone instance for users. See [Publishing](https://github.com/neo4j-labs/neodash/wiki/Publishing) for more on publishing dashboards.
+After building a dashboard, you can chose to deploy a read-only, standalone instance for users. See [Publishing](https://neo4j.com/labs/neodash/2.1/user-guide/publishing/) for more on publishing dashboards.
 
 
 ## Questions / Suggestions

diff --git a/changelog.md b/changelog.md
@@ -1,4 +1,18 @@
-## NeoDash 2.1
+## NeoDash 2.1.2
+The 2.1.2 release contains some bug fixes and minor improvements to the application.
+
+Application changes:
+- Added button to clone (duplicate) a report inside a dashboard.
+- Added option to show/hide labels inside circle packing charts.
+- Changed dashboard layout compaction strategy to be more natural.
+- Fixed card headers not rendering correctly in read-only mode.
+- Fixed rendering issues for table columns containing null values.
+
+Operational changes:
+- Added support for username/password environment variables in Docker.
+
+
+## NeoDash 2.1.0, NeoDash 2.1.1
 The 2.1 release is a major update to the NeoDash application.
 
 Main updates:
@@ -216,4 +230,3 @@ UX improvements + bug fixes.
 
 
 
-
diff --git a/docs/modules/ROOT/pages/developer-guide/configuration.adoc b/docs/modules/ROOT/pages/developer-guide/configuration.adoc
@@ -2,7 +2,7 @@
 
 When using a custom NeoDash deployment, there are several settings that
 can be configured. These mostly relate to
-link:../Standalone-Mode[Standalone Mode] and SSO configurations.
+link:../standalone-mode[Standalone Mode] and SSO configurations.
 
 For a simple (non-Dockerized) deployment, these configuration parameters
 can be changed by modifying `dist/config.json` after you have built the

diff --git a/docs/modules/ROOT/pages/developer-guide/contributing.adoc b/docs/modules/ROOT/pages/developer-guide/contributing.adoc
@@ -17,5 +17,5 @@ applicable).
 
 If you have a request for a feature, or have found a bug, consider
 creating an https://github.com/neo4j-labs/neodash/issues[issue] on
-GitHub. Please include a link:./Testing#debug-report[Debug Report] if
+GitHub. Please include a link:./testing#debug-report[Debug Report] if
 available.
diff --git a/docs/modules/ROOT/pages/developer-guide/design.adoc b/docs/modules/ROOT/pages/developer-guide/design.adoc
@@ -21,7 +21,6 @@ actions)
 ....
 conf: nginx configuration for Docker image.
 dist: directory for generated webpack files.
-doc: documentation (to be moved to wiki)
 node_modules: downloaded dependencies
 public: style files/images. Runtime app config.
 scripts: utility scripts for deployment.

diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
@@ -1,5 +1,5 @@
 = Introduction
-This wiki contains information on getting started with NeoDash - A Low-Code Dashboard Builder for Neo4j.
+This portal contains information on getting started with NeoDash - A Low-Code Dashboard Builder for Neo4j.
 
 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.
 

diff --git a/docs/modules/ROOT/pages/user-guide/dashboards.adoc b/docs/modules/ROOT/pages/user-guide/dashboards.adoc
@@ -138,7 +138,7 @@ allowed to take before being cancelled automatically. Increase this if
 you have complex analytical queries.
 
 |Disable Row Limiting |Yes |off |If enabled, the automatic
-link:Reports#row-limiting[row limiting] feature of dashboards is
+link:reports#row-limiting[row limiting] feature of dashboards is
 disabled.
 
 |Page Number |No |0 |The current page number of the dashboard being

diff --git a/docs/modules/ROOT/pages/user-guide/index.adoc b/docs/modules/ROOT/pages/user-guide/index.adoc
@@ -3,10 +3,10 @@
 The following pages contain everything you need to get started with NeoDash.
 
 
-* link:../Quickstart[Quickstart] tells you how to get started with NeoDash right away.
-* link:Dashboards[Dashboards] elaborates on how dashboards are created and used in
+* link:../quickstart[Quickstart] tells you how to get started with NeoDash right away.
+* link:dashboards[Dashboards] elaborates on how dashboards are created and used in
 NeoDash.
-* link:Pages[Pages] explains how to manage pages inside a dashboard.
-* link:Reports[Reports] contains information on how a report works, and lists the
+* link:pages[Pages] explains how to manage pages inside a dashboard.
+* link:reports[Reports] contains information on how a report works, and lists the
 different types that can be used.
-* link:Publishing[Publishing] explains how to publish a dashboard for others to view.
+* link:publishing[Publishing] explains how to publish a dashboard for others to view.
diff --git a/docs/modules/ROOT/pages/user-guide/reports/index.adoc b/docs/modules/ROOT/pages/user-guide/reports/index.adoc
@@ -104,17 +104,17 @@ will be used. If no rules are matched, the default style will be used.
 To learn more about a specific report type, see one of the following
 pages: 
 
-- link:Table[Table] 
-- link:Graph[Graph]
-- link:Bar%20Chart[Bar Chart]
-- link:Pie%20Chart[Pie Chart] 
-- link:Line%20Chart[Line Chart] 
-- link:Sunburst[Sunburst]
-- link:Circle%20Packing[Circle Packing] 
-- link:Treemap[Treemap]
-- link:Map[Map]
-- link:Single%20Value[Single Value] 
-- link:Raw%20JSON[Raw JSON] 
-- link:Parameter%20Select[Parameter Select] 
-- link:iFrame[iFrame]
-- link:Markdown[Markdown]
+- link:table[Table] 
+- link:graph[Graph]
+- link:bar-chart[Bar Chart]
+- link:pie-chart[Pie Chart] 
+- link:line-chart[Line Chart] 
+- link:sunburst[Sunburst]
+- link:circle-packing[Circle Packing] 
+- link:treemap[Treemap]
+- link:map[Map]
+- link:single-value[Single Value] 
+- link:raw-json[Raw JSON] 
+- link:parameter-select[Parameter Select] 
+- link:iframe[iFrame]
+- link:markdown[Markdown]
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "neodash",
-  "version": "2.1.2",
+  "version": "2.1.3",
   "description": "NeoDash - Neo4j Dashboard Builder",
   "neo4jDesktop": {
     "apiVersion": "^1.2.0"

diff --git a/release-notes.history.md b/release-notes.history.md
@@ -1,4 +1,18 @@
-## NeoDash 2.1
+## NeoDash 2.1.2
+The 2.1.2 release contains some bug fixes and minor improvements to the application.
+
+Application changes:
+- Added button to clone (duplicate) a report inside a dashboard.
+- Added option to show/hide labels inside circle packing charts.
+- Changed dashboard layout compaction strategy to be more natural.
+- Fixed card headers not rendering correctly in read-only mode.
+- Fixed rendering issues for table columns containing null values.
+
+Operational changes:
+- Added support for username/password environment variables in Docker.
+
+
+## NeoDash 2.1.0, NeoDash 2.1.1
 The 2.1 release is a major update to the NeoDash application.
 
 Main updates:

diff --git a/release-notes.md b/release-notes.md
@@ -1,12 +1,11 @@
-## NeoDash 2.1.2
-The 2.1.2 release contains some bug fixes and minor improvements to the application.
+## NeoDash 2.1.3
+The 2.1.3 release contains updates to the map visualization, as well as a new Choropleth map report type.
+Several usability improvements were also added, including fixing all links into the new documentation pages.
 
-Application changes:
-- Added button to clone (duplicate) a report inside a dashboard.
-- Added option to show/hide labels inside circle packing charts.
-- Changed dashboard layout compaction strategy to be more natural.
-- Fixed card headers not rendering correctly in read-only mode.
-- Fixed rendering issues for table columns containing null values.
-
-Operational changes:
-- Added support for username/password environment variables in Docker.
+- Extended the map visualization with a heatmap mode & marker clustering.
+- Added a Choropleth map visualization report type.
+- Added support for auto-linking into a predefined database from https://tools.neo4jlabs.com/.
+- Added optional background color setting for reports.
+- Added a new 'resize mode' for page layout creation.
+- Added support for drawing dates on a time chart (in addition to existing datetime types).
+- Fixed broken links in the documentation portal, all in-app links now point to this portal as well.
diff --git a/src/dashboard/drawer/DashboardDrawer.tsx b/src/dashboard/drawer/DashboardDrawer.tsx
@@ -95,7 +95,7 @@ export const NeoDrawer = ({ open, hidden, connection, dashboardSettings, updateD
             </List>
             <Divider />
             <List>
-                <ListItem button onClick={(e) => window.open("https://github.com/neo4j-labs/neodash/wiki/User-Guide", "_blank")}>
+                <ListItem button onClick={(e) => window.open("https://neo4j.com/labs/neodash/2.1/user-guide/", "_blank")}>
                     <ListItemIcon>
                         <LibraryBooksIcon />
                     </ListItemIcon>

diff --git a/src/modal/AboutModal.tsx b/src/modal/AboutModal.tsx
@@ -13,7 +13,7 @@ import BugReportIcon from '@material-ui/icons/BugReport';
 export const NeoAboutModal = ({ open, handleClose, getDebugState }) => {
     const app = "NeoDash - Neo4j Dashboard Builder";
     const email = "[email protected]";
-    const version = "2.1.2";
+    const version = "2.1.3";
 
     const downloadDebugFile = () => {
         const element = document.createElement("a");
@@ -57,7 +57,7 @@ export const NeoAboutModal = ({ open, handleClose, getDebugState }) => {
                         <hr></hr>
                         <h3 style={{ marginBottom: "5px" }}>Extending NeoDash</h3>
                         NeoDash is built with React and <a target="_blank" href="https://github.com/adam-cowley/use-neo4j">use-neo4j</a>,
-                        It uses <a target="_blank" href="https://github.com/neo4j-labs/charts">charts</a> to power some of the visualizations, and openstreetmap for the map view.<br />
+                        It uses <a target="_blank" href="https://github.com/neo4j-labs/charts">charts</a> to power some of the visualizations, and <a target="_blank" href="https://www.openstreetmap.org/">Open Streetmap</a> for the map view.<br />
                         You can also extend NeoDash with your own visualizations. Check out the developer guide in the <a target="_blank" href="https://github.com/neo4j-labs/neodash/"> project repository</a>.
                         <hr></hr>
                         <h3 style={{ marginBottom: "5px" }}>Contact</h3>

diff --git a/src/modal/ReportHelpModal.tsx b/src/modal/ReportHelpModal.tsx
@@ -31,7 +31,7 @@ export const NeoReportHelpModal = ({ open, handleClose }) => {
                 <DialogContentText> A report is the smallest building block of your dashboard.
                     Each report runs a single Cypher query that loads data from your database.
                     By changing the report type, different visualizations can be created for the data.
-                    See the <a href="https://github.com/neo4j-labs/neodash/wiki/Reports">Documentation</a> for more on reports.
+                    See the <a href="https://neo4j.com/labs/neodash/2.1/user-guide/reports/">Documentation</a> for more on reports.
                     <br></br><br></br>
                     <table>
                         <tr>

diff --git a/src/modal/ShareModal.tsx b/src/modal/ShareModal.tsx
@@ -107,7 +107,7 @@ export const NeoShareModal = ({ connection, loadDashboardListFromNeo4j, loadData
                 <DialogContent style={{ width: "1000px" }}>
                     <DialogContentText>
                         This window lets you create a temporary share link for your dashboard.
-                        Keep in mind that share links are not intended as a way to publish your dashboard for users, see the <a href="https://github.com/neo4j-labs/neodash/wiki/Publishing">wiki</a> for more on publishing.
+                        Keep in mind that share links are not intended as a way to publish your dashboard for users, see the <a href="https://neo4j.com/labs/neodash/2.1/user-guide/publishing/">documentation</a> for more on publishing.
                         <br />
                         <hr /><br />
                         Step 1: Select a dashboard to share.