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

Updated :play intro with new screenshots and text. #1283

Merged
merged 5 commits into from
Feb 28, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
157 changes: 105 additions & 52 deletions src/browser/documentation/guides/intro.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ const slides = [
<Slide key="s1">
<div className="col-sm-3">
<h3>Introduction</h3>
<p className="lead">Getting started with Neo4j Browser</p>
<p className="lead">Neo4j Browser User Interface </p>
</div>
<div className="col-sm-6">
<p>
Expand Down Expand Up @@ -55,26 +55,45 @@ const slides = [
</div>
<div className="col-sm-5">
<p>
The editor is the primary interface for entering and running commands.
Enter Cypher queries to work with graph data. Use client-side commands
like
<code>:help</code> for other operations.
Editor pane is used to edit and run for Cypher statements and Browser
commands. Browser commands begin with <code>:</code>, for example{' '}
<code>:help</code>
</p>
<table>
<tr>
shkirando marked this conversation as resolved.
Show resolved Hide resolved
<td className="padding5">Execute current command</td>
<td>
{' '}
<b>Cmd-Return</b>
HerrEmil marked this conversation as resolved.
Show resolved Hide resolved
</td>
</tr>
<tr>
<td className="padding5">Previous command in history</td>
<td>
<b>Cmd-Up-Arrow</b>
</td>
</tr>
<tr>
<td className="padding5">Next command in history</td>
<td>
<b>Cmd-Down-Arrow</b>
</td>
</tr>
</table>
<p></p>
<p>
You can view the complete list of keybinding anytime by running{' '}
HerrEmil marked this conversation as resolved.
Show resolved Hide resolved
<code>:help keys</code>
</p>
<ul>
<li>Single line editing for brief queries or commands</li>
<li>Switch to multi-line editing with {'<shift-enter>'}</li>
<li>Run a query with {'<ctrl-enter>'}</li>
<li>History is kept for easily retrieving previous commands</li>
</ul>
</div>
<div className="col-sm-4">
<img src="./assets/images/screen_editor.png" className="img-responsive" />
<img src="./assets/images/Keystrokes.gif" className="img-responsive" />
</div>
</Slide>,
<Slide key="s3">
<div className="col-sm-3">
<h3>Stream</h3>
<p className="lead">Scrolling series of result frames</p>
<h3>Result frame</h3>
<p className="lead">Most recently executed command or Cypher query.</p>
</div>
<div className="col-sm-5">
<p>
Expand All @@ -83,76 +102,110 @@ const slides = [
order.
</p>
<ul>
<li>Special frames like data visualization</li>
<li>Expand a frame to full screen</li>
<li>Remove a specific frame from the stream</li>
<li>If a frame is pinned it will always stay in the same position. </li>
<li>
You can clear the stream of result frames running <code>:clear</code>{' '}
command.
</li>
<li>
Clear the stream with the <code>:clear</code> command
There are maximum 30 result frames displayed in the stream. You can
change this number in the Settings sidebar.{' '}
</li>
<li>
You can bring up the history of the executed commands and queries by
running <code className="nobreak">:history</code> command.
</li>
<li>
Clear the stream with the <code>:clear</code> command.
HerrEmil marked this conversation as resolved.
Show resolved Hide resolved
</li>
</ul>
</div>
<div className="col-sm-4">
<img src="./assets/images/screen_stream.png" className="img-responsive" />
<img src="./assets/images/Stream.png" className="img-responsive" />
</div>
</Slide>,
<Slide key="s4">
<div className="col-sm-3">
<h3>Frame code view</h3>
<p className="lead">Viewing requests and responses</p>
<h3>Reusable frame</h3>
<p className="lead">Instead of the stream</p>
</div>
<div className="col-sm-5">
<p>
The code tab displays everything sent to and received from the Neo4j
server, including:
You can also iterate in the same frame instead of generating a
scrollable stream of frames.
</p>
<ul>
<li>Request URI, HTTP method and headers</li>
<li>Response HTTP response code and headers</li>
<li>Raw request and response content in JSON format</li>
</ul>
<p>Adjust your preferences in the Settings sidebar tab.</p>
</div>
<div className="col-sm-4">
<img
src="./assets/images/screen_code_frame.png"
className="img-responsive"
/>
<img src="./assets/images/ReusableFrame.gif" className="img-responsive" />
</div>
</Slide>,
<Slide key="s5">
<div className="col-sm-3">
<h3>Sidebar</h3>
<p className="lead">Convenient clickable access</p>
<h3>Sidebar: Database information</h3>
<p className="lead">Databasse metadata</p>
HerrEmil marked this conversation as resolved.
Show resolved Hide resolved
</div>
<div className="col-sm-5">
<p>
The sidebar expands to reveal different functional panels for common
queries and information.
</p>
<ul>
<li>Database metadata and basic information</li>
<li>Saved scripts organized into folders</li>
<li>Information links for docs and reference</li>
<li>Credits and licensing information</li>
</ul>
When Neo4j is installed, it is initiated with two databases - a{' '}
<code>system</code> database and a default <code>neo4j</code> database.
Launching Neo4j Browser will automatically point us to the{' '}
<code className="nobreak">neo4j default</code> database, shown by the
neo4j$ prompt in the editor.
</div>
<div className="col-sm-4">
<img
src="./assets/images/screen_sidebar.png"
src="./assets/images/SidebarDB_Iinfo.png"
className="img-responsive"
/>
</div>
</Slide>,

<Slide key="s6">
<div className="col-sm-4">
<h3>Next steps</h3>
<p className="lead">
Neo4j is like a mashup of a REPL + lightweight IDE + graph
visualization.
<div className="col-sm-3">
<h3>Sidebar: Favorites</h3>
<p className="lead">Quick way to save your queries</p>
</div>
<div className="col-sm-5">
<p>
Favorite queries or commands can be saved in the local storage and
displayed in the sidebar.{' '}
</p>
<p>
Favorites are global and independent of project or database which means
that you can access your Favorites from Neo4j Browser with different
databases, hosting platforms, and data sets.
</p>
<a play-topic="start">Play start</a> - Back to getting started
</div>
<div className="col-sm-4">
<h3>Keep getting started</h3>
<img src="./assets/images/Favorites.gif" className="img-responsive" />
</div>
</Slide>,

<Slide key="s7">
<div className="col-sm-3">
<h3>Sidebar: Project files</h3>
<p className="lead">Save cypher files to share with your colleagues</p>
</div>
<div className="col-sm-5">
Queries and commands can also be saved as <b>Project files</b>. Project
folder can be reached through Neo4j Desktop and your hard disk.
</div>
<div className="col-sm-4">
<img src="./assets/images/ProjectFiles.gif" className="img-responsive" />
</div>
</Slide>,

<Slide key="s8">
<div className="col-sm-4">
<div>
{' '}
&#127968;
<a play-topic="start">Play start</a> - Back to getting started
</div>
</div>

<div className="col-sm-4">
<h3>Next steps</h3>
<ul className="undecorated">
<li>
<a help-topic="commands">Help commands</a> - Useful Neo4j Browser
Expand Down
Binary file added src/browser/images/Favorites.gif
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 src/browser/images/Keystrokes.gif
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 src/browser/images/ProjectFiles.gif
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 src/browser/images/ReusableFrame.gif
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 src/browser/images/SidebarDB_Iinfo.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 src/browser/images/Stream.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions src/browser/modules/Carousel/style.less
Original file line number Diff line number Diff line change
Expand Up @@ -423,5 +423,7 @@
margin: 6px 0 20px 0;
overflow: hidden;
}

}
.padding5 {padding: 5px; color:'red'}
}