Improve docs & add release note

FylmTM · FylmTM · commit 3eefb5f3fb6a · 2017-01-21T22:35:48.000+02:00
- Add release note for 2.3.0
- Add release section to docs
- Rearrange docs a bit
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -1,18 +1,22 @@
 # Summary
 
+### Documentation
+
 * [Introduction](README.md)
 * [Data sources](data-sources/index.md)
     * [Neo4j - Bolt](data-sources/types/neo4j-bolt.md)
 * [Console](console/index.md)
     * [Log](console/log.md)
-    * [Graph](console/graph/index.md)
-        * [Canvas](console/graph/canvas.md)
+    * [Graph](console/graph.md)
     * [Table](console/table.md)
     * [Parameters](console/parameters.md)
-    * [Plan](console/plan.md)
 * [Cypher](cypher/index.md)
-    * [Syntax](cypher/syntax.md)
+    * [Plan](cypher/plan.md)
     * [Autocompletion](cypher/autocompletion.md)
     * [Refactoring](cypher/refactoring.md)
     * [Inspections](cypher/inspections.md)
     * [Language injections](cypher/language-injections.md)
+
+### Releases
+
+* [2.3.0](releases/2.3.0/index.md)
diff --git a/docs/console/graph.md b/docs/console/graph.md
@@ -2,10 +2,12 @@
 
 ### Canvas
 
-Detailed [more information](canvas.md) about canvas features.
+TODO
 
 ### Entity view
 
+TODO
+
 <!--
 Node information
 Relationship information
diff --git a/docs/console/graph/canvas.md b/docs/console/graph/canvas.md
diff --git a/docs/cypher/index.md b/docs/cypher/index.md
@@ -3,10 +3,11 @@
 ## Execution
 
 Queries can be executed either for Cypher file (in this case data source selection is required), 
-or from data source editor. To open data source editor, right click on data source and choose `Open editor`.
+or from data source editor.
+To open data source editor, right click on data source and choose `Open editor`.
 
-Keyboard shortcut for query execution is *Ctrl + Enter* with the cursor on the query. Alternatively right click on 
-the query statement, select `Graph Database` -> `Execute Query`. 
+Keyboard shortcut for query execution is *Ctrl + Enter* with the cursor on the query.
+Alternatively right click on the query statement, select `Graph Database` -> `Execute Query`. 
 
 If query execution fails, an error hint is displayed. 
 ![plugin screenshot](../screenshots/error_hint.png "Error hint") 
@@ -15,11 +16,13 @@ The hint disappears as soon as any user interaction like mouse movement takes pl
 Afterwards it is possible to view the error details in `Log` tab.
 
 If parameters are needed for query execution, they can be provided in `Paramters` tab in JSON format.
-For instance, for query `MATCH (n) WHERE n.name = $name RETURN n`, parameter could look like `{"name": "Johan"}`.
+For instance, for query `MATCH (n) WHERE n.name = $name RETURN n`,
+parameter could look like `{"name": "Johan"}`.
 
 ![plugin screenshot](../screenshots/query_parameters_sample.png "Providing query parameters")
 
 `Log` tab displays, what parameters where used for query execution.
+
 <!--
 General information
 File type support
diff --git a/docs/cypher/inspections.md b/docs/cypher/inspections.md
@@ -3,13 +3,14 @@
 ### EXPLAIN warnings
 
 Graph database plugin provides a functionality to automatically find any problems with your queries, 
-using `EXPLAIN` queries. Then, all database notifications are displayed as warnings, highlighting problematic parts of
-query.
+using `EXPLAIN` queries.
+Then, all database notifications are displayed as warnings, highlighting problematic parts of query.
 
 ![explain warning screenshot](../screenshots/explain_warning.png)
 
-Under the hood, IntelliJ platform launches inspection for a query without syntax errors, inspection prepends to the 
-query an `EXPLAIN` keyword and executes it against the active data-source silently. 
+Under the hood, IntelliJ platform launches inspection for a query without syntax errors,
+inspection prepends to the query an `EXPLAIN` keyword and executes it against the active
+data-source silently. 
 After all results have been received, database notifications are displayed as warnings.
 
-Inspection is enabled by default, but you can disable it at any time.
+Inspection is enabled by default, but you can disable it at any time.
diff --git a/docs/cypher/language-injections.md b/docs/cypher/language-injections.md
@@ -2,10 +2,6 @@
 
 TODO
 
-### Auto-injections
-
-TODO
-
 <!--
 Neo4j
 Neo4j-ogm
diff --git a/docs/cypher/plan.md b/docs/cypher/plan.md
@@ -1,11 +1,11 @@
 # Console - Plan
 
-When any `EXPLAIN` or `PROFILE` queries are executed, plugin creates a closeable tab in console, which contains the plan
-of query, rendered as tree table.
+When any `EXPLAIN` or `PROFILE` queries are executed, plugin creates a closeable tab in console,
+which contains the plan of query, rendered as tree table.
  
 ![EXPLAIN plan](../screenshots/explain_plan.png)
 
 The plan tab consists of label with an executed query, tree table with plan and label with metadata.
 Note, that `PROFILE` plan table has more columns, because the query is actually executed.
 
-![PROFILE plan](../screenshots/profile_plan.png)
+![PROFILE plan](../screenshots/profile_plan.png)
diff --git a/docs/cypher/syntax.md b/docs/cypher/syntax.md
diff --git a/docs/releases/2.3.0/index.md b/docs/releases/2.3.0/index.md
@@ -0,0 +1,51 @@
+# Release 2.3.0
+
+### Overview
+
+New:
+* Initial support for Cypher query parameters
+* Support for Cypher query EXPLAIN and PROFILE analysis
+* Cypher inspection: analyse queries using EXPLAIN
+
+Improvements:
+* Query database for specific label, relationship type or property via context menu
+* Show error popup if query execution fails
+
+Bugfixes:
+* Variable refactoring in Cypher is now performed in single query, rather than whole file
+* Syntax errors are now visible if query is highlighted with green border
+* Fixed canvas background in Graph view for Darcula theme
+
+### New
+
+#### Cypher query parameters
+
+Support for Cypher query parameters has arrived!
+
+To access this functionality open `Graph Database Console` and go to `Parameters` tab.
+There you can find editor where you can specify desired parameters,
+that will be automatically picked up on query execution and passed to a database.
+
+![Query parameters support](../../gifs/2.3.0/params.gif)
+
+#### Explore `EXPLAIN` and `PROFILE` result
+
+If you will try to analyse query using `EXPLAIN` or `PROFILE` keywords you will
+see a new tab created in `Graph Database Console` with analysis result.
+
+Tab contains:
+* Query that was executed
+* Query execution plan in a tree format
+* Information about Cypher planner, runtime and execution time
+
+![Explore profile result](../../gifs/2.3.0/profile.gif)
+
+#### Inspection - Analyse query using `EXPLAIN`
+
+Cypher queries now will be automatically analysed using `EXPLAIN`.
+
+In order to make this work you need to:
+* Write queries in Data Source editor
+* Have Neo4j running for this data source
+
+![EXPLAIN analysis warning](../../gifs/2.3.0/warning.gif)
diff --git a/docs/releases/index.md b/docs/releases/index.md
@@ -0,0 +1,3 @@
+# Releases
+
+* [Release 2.3.0](2.3.0/index.md)
diff --git a/platform/src/main/resources/graphdb/messages/GraphBundle.properties b/platform/src/main/resources/graphdb/messages/GraphBundle.properties
@@ -3,7 +3,7 @@ updater.notification=<br/>\
 <b>New:</b><br/>\
 - Initial support for Cypher query parameters<br/>\
 - Support for Cypher query EXPLAIN and PROFILE analysis<br/>\
-- Inspection: analyse queries using EXPLAIN<br/>\
+- Cypher inspection: analyse queries using EXPLAIN<br/>\
 <b>Improvements:</b><br/>\
 - Query database for specific label, relationship type or property via context menu<br/>\
 - Show error popup if query execution fails<br/>\

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Releases`
	`2`	`+`
	`3`	`+* [Release 2.3.0](2.3.0/index.md)`