-
Notifications
You must be signed in to change notification settings - Fork 8
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
New Browser preview guide #46
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some editorial stuff. Looks like a great guide overall!
|
||
== Introduction | ||
|
||
Welcome to the New Browser Preview! We’ve been busy modernizing our applications as part of our integrated cloud offering Neo4j Aura and are now bringing those benefits to the Browser that we bundle with the Neo4j distribution. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Welcome to the New Browser Preview! We’ve been busy modernizing our applications as part of our integrated cloud offering Neo4j Aura and are now bringing those benefits to the Browser that we bundle with the Neo4j distribution. | |
Welcome to the New Browser Preview! | |
We have modernized our applications as part of our integrated cloud offering Neo4j Aura and are now bringing those benefits to the Browser that we bundle with the Neo4j distribution. |
|
||
Welcome to the New Browser Preview! We’ve been busy modernizing our applications as part of our integrated cloud offering Neo4j Aura and are now bringing those benefits to the Browser that we bundle with the Neo4j distribution. | ||
|
||
If you use Neo4j Aura you’ll see the same capabilities as this New Browser Preview offered under the “Query” part of the integrated experience. This offers the same capabilities as you find here, along with new features you might expect from a cloud offering, like user content being backed by cloud storage so it’s available wherever you login. For our standalone Browser, content will continue to be backed by LocalStorage and therefore tied to the browser you use to access the application. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you use Neo4j Aura you’ll see the same capabilities as this New Browser Preview offered under the “Query” part of the integrated experience. This offers the same capabilities as you find here, along with new features you might expect from a cloud offering, like user content being backed by cloud storage so it’s available wherever you login. For our standalone Browser, content will continue to be backed by LocalStorage and therefore tied to the browser you use to access the application. | |
If you use Neo4j Aura, you’ll see the same capabilities as this New Browser Preview offered under the **Query** part of the integrated experience. | |
However, Query is slightly different since it is part of Neo4j's cloud solution. | |
One example is that user content is backed by cloud storage and available wherever you log in. | |
For our standalone Browser, content will continue to be backed by LocalStorage and therefore tied to the browser you use to access the application. |
|
||
== New Cypher editor | ||
|
||
One of the biggest improvements is the new editor, now built from the same source as the underlying Cypher Language. With Cypher evolving more rapidly than ever before, it’s never been more important to keep pace with the latest language features. Here are a few ways the new editor helps you do that: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One of the biggest improvements is the new editor, now built from the same source as the underlying Cypher Language. With Cypher evolving more rapidly than ever before, it’s never been more important to keep pace with the latest language features. Here are a few ways the new editor helps you do that: | |
One of the biggest improvements is the new editor, now built from the same source as the underlying Cypher Language. | |
With Cypher evolving more rapidly than ever before, it’s never been more important to keep pace with the latest language features. | |
Here are a few ways the new editor helps you do that: |
|
||
image::cypher-editor-inline-help.png[] | ||
|
||
Cypher linting:: One of the single most useful new features we’ve added to the editor is Cypher linting, so you’ll now see useful warnings and errors _before_ running a query. This really helps shorten the feedback loop, meaning you don’t have to run a query to spot syntactic or semantic errors. This is especially useful when editing larger queries or using new language constructs where you might not be so familiar with what to expect. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cypher linting:: One of the single most useful new features we’ve added to the editor is Cypher linting, so you’ll now see useful warnings and errors _before_ running a query. This really helps shorten the feedback loop, meaning you don’t have to run a query to spot syntactic or semantic errors. This is especially useful when editing larger queries or using new language constructs where you might not be so familiar with what to expect. | |
Cypher linting:: One of the single most useful new features in the editor is Cypher linting, so you’ll now see useful warnings and errors _before_ running a query. | |
This helps shorten the feedback loop, meaning you don’t have to run a query to spot syntactic or semantic errors. | |
This is especially useful when editing larger queries or using new language constructs where you may not be as familiar with what to expect. |
|
||
image::cypher-editor-linting.png[] | ||
|
||
Cypher reference:: As a complement to the in-editor help, we now also provide a searchable Cypher reference in the sidebar. This is useful if you want to check the syntax of a Cypher construct or want a refresher, for example, of which temporal functions exist and how to use them. The reference also provides links to the cypher manual for more in depth explanations and examples. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cypher reference:: As a complement to the in-editor help, we now also provide a searchable Cypher reference in the sidebar. This is useful if you want to check the syntax of a Cypher construct or want a refresher, for example, of which temporal functions exist and how to use them. The reference also provides links to the cypher manual for more in depth explanations and examples. | |
Cypher reference:: As a complement to the in-editor help, a searchable Cypher reference is now available in the sidebar. | |
This is useful if you want to check the syntax of a Cypher construct or want a refresher, for example, of which temporal functions exist and how to use them. | |
The reference also provides links to the Cypher manual for more in-depth explanations and examples. |
|
||
The familiar and convenient up/down arrow history feature that remains, but has been supplemented with a dedicated sidebar to review and manage history, allowing history to be selectively deleted or exported. | ||
|
||
For convenience, the history available in the sidebar is also searchable via a fuzzy search from the main editor, allowing you to quickly find a query in your history. This can be invoked from the … more menu on the main editor or via Ctrl+R |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For convenience, the history available in the sidebar is also searchable via a fuzzy search from the main editor, allowing you to quickly find a query in your history. This can be invoked from the … more menu on the main editor or via Ctrl+R | |
For convenience, the history available in the sidebar is also searchable via a fuzzy search from the main editor, allowing you to quickly find a query in your history. | |
This can be invoked from the […] more menu on the main editor or via Ctrl+R |
|
||
== Improved saved Cypher experience | ||
|
||
The “Favorites” experience from Browser is now “Saved Cypher” and provides a refreshed way of creating and managing Cypher. Among other things, you can now more readily re-order items among nested folders and cypher saved from the editors recalls the last folders used for convenience. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The “Favorites” experience from Browser is now “Saved Cypher” and provides a refreshed way of creating and managing Cypher. Among other things, you can now more readily re-order items among nested folders and cypher saved from the editors recalls the last folders used for convenience. | |
The “Favorites” experience from Browser is now “Saved Cypher” and provides a refreshed way of creating and managing Cypher. | |
Among other things, you can now more readily re-order items among nested folders and Cypher saved from the editor recalls the last folders used for convenience. |
Not sure exactly what the last sentence is supposed to say, you can re-order items among nested folders and from Cypher saved from the editor, I get that, but the last bit "recalls the last folders used for convenience", I don't know what that refers to.
|
||
== Revised paramaters | ||
|
||
The parameters implementation has rationalized the `:param` and `:params` variants that differed in Browser. While singular and plural versions of the command are respected they behave the same way and offer support for setting parameters singularly via the arrow syntax `:param a => 1` or multiply via cypher maps `:param {a:1, b: 2}`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The parameters implementation has rationalized the `:param` and `:params` variants that differed in Browser. While singular and plural versions of the command are respected they behave the same way and offer support for setting parameters singularly via the arrow syntax `:param a => 1` or multiply via cypher maps `:param {a:1, b: 2}`. | |
The parameters implementation has rationalized the `:param` and `:params` variants that differed in Browser. | |
While singular and plural versions of the command are respected, they behave the same way and offer support for setting parameters singularly via the arrow syntax `:param a => 1` or multiply via cypher maps `:param {a:1, b: 2}`. |
|
||
== And finally... | ||
|
||
We hope you enjpy using the new Browser preview. Please note that the following are not yet supported: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We hope you enjpy using the new Browser preview. Please note that the following are not yet supported: | |
Hope you enjoy using the new Browser preview. | |
Please note that the following are not yet supported: |
- `:server user [add | list]` commands to support user management - this is possible via the cypher surface, see docs for more details. | ||
- GraSS and the `:style` command to set custom styles. Some basic styling support is provided via the UI to change colors, captions and size as well as ordering the priority of styles when multiple labels apply to a node. | ||
|
||
This new Browser preview will ultimately replace the existing Browser as the default and later only experience. If these items or anything else is important to you, please head over to https://feedback.neo4j.com/query and drop your feedback there. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This new Browser preview will ultimately replace the existing Browser as the default and later only experience. If these items or anything else is important to you, please head over to https://feedback.neo4j.com/query and drop your feedback there. | |
This new Browser preview will ultimately replace the existing Browser as the default and later only experience. | |
If these items or anything else is important to you, please head over to https://feedback.neo4j.com/query and drop your feedback there. |
@AlexicaWright could you take a review of this please?
I think the managing of image assets needs some rework for when we put this in the browser preview, but I think it works for local review.
The guide is called
browser-preview.workspace.adoc
and the image assets are in the root.