Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Neo4j dashboards in Aura #581

Open
wants to merge 8 commits into
base: console
Choose a base branch
from
Open

Conversation

rsill-neo4j
Copy link
Contributor

@rsill-neo4j rsill-neo4j commented Jan 16, 2025

WiP

PR to have a preview that can be shared

= Getting started with dashboards
:description: Follow these steps for a working example of Neo4j Aura dashboards.

Set up a working example of Neo4j Aura dashboards.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The decision was made to include Dashboards inside Desktop 2.0. The functionality will be 95% identical (everything except sharing). Does it make sense to have one docs portal for both? In that case we should call it "Neo4j Dashboards" instead of "Neo4j Aura Dashboards" I think.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hm... i wonder if it should be part of the aura docs then (probably yes, because UPX and aura first? @fiquick @AlexicaWright )

there's also the desktop docs here:
https://neo4j.com/docs/desktop-manual/current/

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Desktop 2.0 will get their own docs shortly. However, the current Desktop docs don't include anything but links to its Graph Apps. Desktop 2 docs will follow the same example, which is to say that yes, Aura first.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @rsill-neo4j @AlexicaWright ! Good to know.
Regardless I think the name :Neo4j Aura Dashboards" doesn't fit very well. I'd rather stick with the official name "Neo4j Dashboards".

See link:https://neo4j.com/docs/getting-started/appendix/example-data/#_available_datasets[Available datasets] for alternative datasets.
However, the rest of this page refers to the movie recommendations dataset.

To add the sample data set in Aura:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The way we make examples datasets available for people will change with the new PLG initiative, it will likely just be a button from the developer home. I'm wondering whether we should write the docs to use the new easy samples when available.


Create a new dashboard:

. In the *Dashboards* page, click *New Dashboard* at the top right.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New Dashboard --> Create Dashboard

////


== Advanced settings

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will need to update these when we know the set of advanced settings we have for the preview release

Copy link

@nielsdejong nielsdejong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added some comments. Since there's a lot we can ignore for the internal preview, I suggest we hide the sections from the navbar and do not link to them (yet).

We can still leave the files as a structural template, but make sure people can't find them. When we go public we should make sure they are also not indexed by search engines.

// * Share your dashboards across your team or your company


== Aura dashboards vs NeoDash commercial

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should position NeoDash commercial here.
For our Aura users the new Dashboards app will be the suggested experience, so introducing NeoDash could be confusing.

link:https://neo4j.com/docs/neodash-commercial/[NeoDash commercial] is Neo4j's standalone dashboard solution.
By contrast, Neo4j Aura dashboards is a part of the unified Aura console experience and lets you work with dashboards directly in Aura without application switch.

== Aura dashboards vs Bloom

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While I think explaining the differences between Bloom makes sense I wouldn't put this on the main page. Same goes for the BI connector.

I'd either put this inside 'Integrations' or create another page for it.

@@ -0,0 +1,4 @@
= Integrations

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will probably not happen until later this year, we can leave this out for Q1.

The examples on this page refer to dataset.


== Create a dashboard

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should have an image for this header as well

////


== Rule-based styling

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove rule-based styling sections for each chart, this will come later in the year.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same goes for report actions btw

@@ -0,0 +1,8 @@
= Working with dashboards

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The entirety of the 'Working with Dashboards' section is out of scope for the internal preview, except for 'Managing dashboards'.

@@ -0,0 +1,4 @@
= Advanced features

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of scope for Q1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants