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

restructure quickstart and edits to user management #610

Merged
merged 8 commits into from
Feb 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,12 @@ Generic Start
** xref:visual-tour/index.adoc[Visual tour]

* Quick start
** xref:getting-started/quick-start-guide.adoc[Quick start guide]
** xref:cloud-providers.adoc[Cloud provider marketplaces]
** xref:getting-started/create-account.adoc[Create an account]
** xref:getting-started/create-instance.adoc[Create an instance]
** xref:getting-started/connect-instance.adoc[Connect to an instance]
** xref:getting-started/migrate-metadata.adoc[Migrate metadata from Workspace]

* xref:cloud-providers.adoc[Cloud provider marketplaces]

* Manage instances
** xref:managing-instances/instance-actions.adoc[Instance actions]
Expand Down
Binary file modified modules/ROOT/images/connectionbanner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/connectionbanner1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/ROOT/images/connectionmodal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/connectionmodalnonremote.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 39 additions & 0 deletions modules/ROOT/pages/getting-started/connect-instance.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
[[connect-to-instance]]
= Connect to an instance
:description: This page describes how to connect to an instance in the new Neo4j Aura console.

To interact with a database in an instance, you need to establish a connection.

. Go to *Import*, *Explore* or *Query*.
. Select *Status* and from there you can connect to an instance.
. You may need your *Username* and *Password* credentials.

[.shadow]
.Connection banner
image::connectionbanner1.png[]

[.shadow]
.Connection modal
image::connectionmodalnonremote.png[width=300]

[cols="20%,80%"]
|===
| Field | Description

|Connection method
|The protocol is used for the communication between the Neo4j database server and the client application or tool.
The default is `neo4j+s//`.
// For more information about connection schemes, see link:https://neo4j.com/docs/operations-manual/current/configuration/connectors/[Operations Manual -> Configure network connectors] and link:https://neo4j.com/docs/bolt/current/bolt/[Bolt Protocol].

// |Connection URL
// |You can get this from your instance details

|Single sign-on
|If this is set up, you can use SSO.

|Database user
|Neo4j by default

|Password
|You are given the password when you initially create the instance
|===
11 changes: 11 additions & 0 deletions modules/ROOT/pages/getting-started/create-account.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[[aura-create-account]]
:description: This page describes how to create a Neo4j Aura account.

= Create an account

To access Neo4j Aura, you need to have an Aura account.
Navigate to link:https://console.neo4j.io[Neo4j Aura console] and follow the instructions for registration.
Once you have accepted the terms and conditions and verified your email address, you can start using the console.

The console exists in two versions,the new console, and the classic experience, as mentioned in xref:index.adoc[About Neo4j Aura console].
You can toggle between the different versions, via the account dropdown in the top right corner.
27 changes: 27 additions & 0 deletions modules/ROOT/pages/getting-started/create-instance.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[[create-instance]]
= Create an instance
:description: This page describes how to create an instance in the new Neo4j Aura console.

There are two types of Aura instances:

* **AuraDB** (the default Aura instance type)
* **AuraDS** (the xref:graph-analytics/index.adoc#aura-ds[fully managed version] of Neo4j Graph Data Science)

Select the type of instance using the switch on the top right, then choose the plan that best suits your needs.
You can upgrade your plan later if your needs change.

You can optionally enable additional features:

* xref:graph-analytics/index.adoc#aura-gds-plugin[Graph Analytics plugin] to add graph analytics capabilities (**AuraDB Professional only**)
* xref:managing-instances/instance-details.adoc#aura-vector-optimization[Vector optimization] to enhance performance for vector-based operations

After selecting **Next**, your instance is created.
A password is generated for the instance, ensure to either copy or download it, as it will **not** be recoverable after.
The password is required to access your instance later.

[NOTE]
====
You can only create **one Free instance** per account.
To create more instances, you need to upgrade your plan.
See link:https://neo4j.com/pricing/[Neo4j Pricing] for more information on the different plans.
====
51 changes: 51 additions & 0 deletions modules/ROOT/pages/getting-started/migrate-metadata.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
[[aura-migrate-metadata]]
= Migrate metadata from Workspace
:description: This describes how to migrate metadata from Neo4j Workspace to the new Neo4j Aura Console.

If you have an Aura instance created in the classic Aura console (refer to xref:new-console.adoc[New Neo4j Aura console] for comparison), you can migrate the metadata from Workspace to the new console and continue working with your data in the new experience.
The metadata includes the data model and saved Cypher queries.

== Data model

From the *Import* tab in Workspace, open the more menu (*...*) and download the model, with or without data.

[.shadow]
image::export-model.png[width=300]

Then navigate to the new console and select *Import* -> *Graph models*.
Once you select *New graph model*, you access the more menu (*...*), similar to Workspace, and select *Open model* with or without data.

[.shadow]
image::import-model.png[width=600]

Note that if you have downloaded your data with the model, you can also go a different route via *Import* -> *Data sources* and select *New data source* and then import locally from files.
This leads you to the same *Import* frame as the first route and you can use the more menu (*...*) to open the model *with* your data.

== Saved Cypher

Any saved Cypher snippets can be downloaded from the *Query* tab in Workspace.
From the Saved Cypher drawer, use the *Export* button to download selected queries as a _.csv_ file.

[.shadow]
image::export-saved-cypher.png[width=300]

In the new console, navigate to the *Query* tab and open the *Saved Cypher* drawer.
Use the *Import* button and select the _.csv_ file you downloaded from Workspace.

[.shadow]
image::import-saved-cypher.png[width=400]

== Perspectives

Perspectives, except for the default Perspective (which is automatically re-created in the new console), can be exported from the Perspective drawer in Workspace.
Use the *Export* option on the Perspective you want to save.
It is exported as a _.json_ file.

[.shadow]
image::export-perspective.png[width=300]

In the new console, navigate to the *Explore* tab and open the *Perspective* drawer.
Use the *Import* option and select the _.json_ file you downloaded from Workspace.

[.shadow]
image::import-perspective.png[width=600]
138 changes: 0 additions & 138 deletions modules/ROOT/pages/getting-started/quick-start-guide.adoc

This file was deleted.

6 changes: 3 additions & 3 deletions modules/ROOT/pages/managing-instances/instance-actions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ You cannot clone from a Neo4j latest version instance to a Neo4j version 4 insta

. From the more menu (*...*) on the instance you want to clone, select *Clone to* and then *New instance* from the contextual menu.
. Set your desired settings for the new database.
For more information on AuraDB database creation, see xref:getting-started/quick-start-guide.adoc#create-instance[Create an instance].
For more information on AuraDB database creation, see xref:getting-started/create-instance.adoc[Create an instance].
. Check the *I accept* box and select *Create*.
+
[WARNING]
Expand Down Expand Up @@ -182,10 +182,10 @@ label:AuraDB-Business-Critical[]

Admins can mark a database instance as `production` in AuraDB Virtual Dedicated Cloud and AuraDB Business Critical.

When Neo4j updates Aura Database versions, instances marked as `production` are last to have the Aura Database version updated.
When Neo4j updates Aura Database versions, instances marked as `production` are last to have the Aura Database version updated.
Because updates are applied to these database instances after other database instances receive updates, you can monitor any potential impact on less critical instances first.

After marking the instance as `production` the label is applied immediately, and all instance actions (such as pause or clone) are temporarily unavailable while the instance is set to `production` in the Neo4j backend.
After marking the instance as `production` the label is applied immediately, and all instance actions (such as pause or clone) are temporarily unavailable while the instance is set to `production` in the Neo4j backend.

Use the more menu (*...*) on the instance card to mark it as `production`.

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/new-console.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:description: This page highlights the main differences between the new and classic concoles.
= Neo4j Aura console
= New Neo4j Aura console
Copy link
Contributor

Choose a reason for hiding this comment

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

Isn't there any official name rather than "New console"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

No, it is just Aura console. I decided to put an extra "New" in there for differentiation, since the section deals with things that are new in the new experience (we can't fix poor design with good documentation but we sure can try).

Copy link
Contributor

Choose a reason for hiding this comment

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

I see. It's just that someone seeing this page for the first time will not know what the "old" one is (unless they keep reading through). I don't have any good suggestions though.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I don't think anyone will just land here, they'll land in the introduction, I think.


The new console is an evolution of the classic Aura console, updated to enhance the experience with Neo4j Aura.
It integrates the features and functionalities of various tools, services, and operations from the Neo4j catalog.
Expand Down
Loading