Fix naming conventions in user_technical

Summary:
* Prefix filenames with order in which they should appear in the sidebar.
* Fix links

Reviewers: buda

Reviewed By: buda

Differential Revision: https://phabricator.memgraph.io/D1618
This commit is contained in:
Ivan Paljak 2018-09-27 14:43:32 +02:00
parent 1fd9a72e10
commit f53343a415
25 changed files with 57 additions and 77 deletions

View File

@ -11,11 +11,29 @@ data structures, multi-version concurrency control and asynchronous IO.
## Contents
* [About Memgraph](#about-memgraph)
* [Quick Start](quick_start.md)
* [Tutorials](tutorials/tutorials_overview.md)
* [How-to Guides](how-to_guides/how-to_guides_overview.md)
* [Concepts](concepts/concepts_overview.md)
* [Reference Guide](reference_guide/reference_overview.md)
* [Quick Start](01_quick-start.md)
* [Tutorials](tutorials/02_tutorials-overview.md)
* [Analysing TED Talks](tutorials/03_analyzing-TED-talks.md)
* [Graphing the Premier League](tutorials/04_graphing-the-premier-league.md)
* [Exploring the European Road Network](tutorials/05_exploring-the-european-road-network.md)
* [How-to Guides](how_to_guides/01_how-to-guides-overview.md)
* [Import Tools](how_to_guides/02_import-tools.md)
* [Programmatic Querying](how_to_guides/03_programmatic-querying.md)
* [How to Ingest Data Using Kafka](how_to_guides/04_how-to-ingest-data-using-kafka.md)
* [Concepts](concepts/01_concepts_overview.md)
* [Storage](concepts/02_storage.md)
* [Graph Algorithms](concepts/03_graph-algorithms.md)
* [Indexing](concepts/04_indexing.md)
* [Reference Guide](reference_guide/01_reference-overview.md)
* [Reading Existing Data](reference_guide/02_reading-existing-data.md)
* [Writing New Data](reference_guide/03_writing-new-data.md)
* [Reading and Writing](reference_guide/04_reading-and-writing.md)
* [Indexing](reference_guide/05_indexing.md)
* [Graph Algorithms](reference_guide/06_graph-algorithms.md)
* [Graph Streams](reference_guide/07_graph-streams.md)
* [Dynamic Graph Partitioner](reference_guide/08_dynamic-graph-partitioner.md)
* [Other Features](reference_guide/09_other-features.md)
* [Differences](reference_guide/10_differences.md)
* [Upcoming Features](upcoming-features.md)
[//]: # (Nothing should go below the contents section)

View File

@ -6,6 +6,6 @@ are recommended for advanced users and other graph database enthusiasts.
So far we have covered the following topics:
* [Data Storage](storage.md)
* [Graph Algorithms](graph_algorithms.md)
* [Indexing](indexing.md)
* [Data Storage](02_storage.md)
* [Graph Algorithms](03_graph-algorithms.md)
* [Indexing](04_indexing.md)

View File

@ -26,7 +26,7 @@ usually found in `/etc/memgraph/memgraph.conf`.
In addition to the above mentioned data durability and recovery, a
snapshot file may be generated using *Memgraph's* import tools. For more
information, take a look at the [Import Tools](../how-to_guides/import_tools.md)
information, take a look at the [Import Tools](../how_to_guides/02_import-tools.md)
article.
## Storable Data Types

View File

@ -152,5 +152,5 @@ be as precise as possible in order to have a more performant query.
### Where to next?
For some real-world application of WSP we encourage you to visit our article
on [exploring the European road network](../tutorials/exploring_the_european_road_network.md)
on [exploring the European road network](../tutorials/04_exploring-the-european-road-network.md)
which was specially crafted to showcase our graph algorithms.

View File

@ -6,6 +6,6 @@ guide on how to use certain Memgraph feature or solve a particular problem.
So far we have covered the following topics:
* [Import Tools](import_tools.md)
* [Programmatic Querying](programmatic_querying.md)
* [How to Ingest Data Using Kafka](how_to_ingest_data_using_kafka.md)
* [Import Tools](02_import-tools.md)
* [Programmatic Querying](03_programmatic-querying.md)
* [How to Ingest Data Using Kafka](04_how-to-ingest-data-using-kafka.md)

View File

@ -8,7 +8,7 @@ Memgraph offers easy data import at the source using Kafka as the
high-throughput messaging system.
At this point, we strongly advise you to read the streaming section of our
[reference guide](../reference_guide/graph_streams.md)
[reference guide](../reference_guide/07_graph-streams.md)
In this article, we assume you have a local instance of Kafka. You can find
more about running Kafka [here](https://kafka.apache.org/quickstart).

View File

@ -256,7 +256,7 @@ for some popular programming languages are listed below:
* [PHP](https://github.com/graphaware/neo4j-bolt-php)
We have included some basic usage examples for some of the supported languages
in the article about [programmatic querying](how-to_guides/programmatic_querying.md).
in the article about [programmatic querying](how_to_guides/03_programmatic-querying.md).
### Telemetry {#telemetry}
@ -276,15 +276,15 @@ as a command-line argument when running the executable.
### Where to Next
To learn more about the openCypher language, the user should visit our
[reference guide](reference_guide/reference_overview.md) article.
[reference guide](reference_guide/01_reference-overview.md) article.
For real-world examples of how to use Memgraph, we strongly suggest reading
through the following articles:
* [Analyzing TED Talks](tutorials/analyzing_TED_talks.md)
* [Graphing the Premier League](tutorials/graphing_the_premier_league.md)
* [Exploring the European Road Network](tutorials/exploring_the_european_road_network.md)
* [Analyzing TED Talks](tutorials/02_analyzing-TED-talks.md)
* [Graphing the Premier League](tutorials/03_graphing-the-premier-league.md)
* [Exploring the European Road Network](tutorials/04_exploring-the-european-road-network.md)
Details on what can be stored in Memgraph can be found in the article about
[Data Storage](concepts/storage.md).
[Data Storage](concepts/02_storage.md).
We *welcome and encourage* your feedback!

View File

@ -10,12 +10,12 @@ not yet supported features of the language are listed.
Our reference guide currently consists of the following articles:
* [Reading Existing Data](reading_existing_data.md)
* [Writing New Data](writing_new_data.md)
* [Reading and Writing](reading_and_writing.md)
* [Indexing](indexing.md)
* [Graph Algorithms](graph_algorithms.md)
* [Streaming](streaming.md)
* [Dynamic Graph Partitioner](dynamic_graph_partitioner.md)
* [Other Features](other_features.md)
* [Differences](differences.md)
* [Reading Existing Data](02_reading-existing-data.md)
* [Writing New Data](03_writing-new-data.md)
* [Reading and Writing](04_reading-and-writing.md)
* [Indexing](05_indexing.md)
* [Graph Algorithms](06_graph-algorithms.md)
* [Graph Streams](07_graph-streams.md)
* [Dynamic Graph Partitioner](08_dynamic-graph-partitioner.md)
* [Other Features](09_other-features.md)
* [Differences](10_differences.md)

View File

@ -11,7 +11,7 @@ You can still use the `RETURN` clause to produce results after writing, but it
is not mandatory.
Details on which kind of data can be stored in *Memgraph* can be found in
[Data Storage](../concepts/storage.md) chapter.
[Data Storage](../concepts/02_storage.md) chapter.
### CREATE

View File

@ -158,41 +158,3 @@ to true is matched:
MATCH (n)
RETURN CASE WHEN n.height < 30 THEN "short" WHEN n.height > 300 THEN "tall" END
```
### EXPLAIN
The `EXPLAIN` clause is used to get a visual representation of operations a
given query will perform. This can be a useful tool for understanding the
query execution and fine tuning the behaviour.
NOTE: Query will not be executed. `EXPLAIN` only shows the operations that
would need to be taken.
For example:
```opencypher
EXPLAIN MATCH (n :Person) WHERE n.height < 30 RETURN n;
```
Will display:
```plaintext
* Produce {n}
* Filter
* ScanAllByLabel (n :Person)
```
This makes it evident that indexing on a property value `height` is not used.
We create an index with:
```opencypher
CREATE INDEX ON :Person(height)
```
Running the same `EXPLAIN` will now display:
```plaintext
* Produce {n}
* ScanAllByLabelPropertyRange (n :Person {height})
```

View File

@ -9,6 +9,6 @@ is successfully installed on your system.
So far we have covered the following topics:
* [Analyzing TED Talks](analyzing_TED_talks.md)
* [Graphing the Premier League](graphing_the_premier_league.md)
* [Exploring the European Road Network](exploring_the_european_road_network.md)
* [Analyzing TED Talks](02_analyzing-TED-talks.md)
* [Graphing the Premier League](03_graphing-the-premier-league.md)
* [Exploring the European Road Network](04_exploring-the-european-road-network.md)

View File

@ -6,8 +6,8 @@ information.
We highly recommend checking out the other articles from this series:
* [Exploring the European Road Network](exploring_the_european_road_network.md)
* [Graphing the Premier League](graphing_the_premier_league.md)
* [Exploring the European Road Network](04_exploring-the-european-road-network.md)
* [Graphing the Premier League](03_graphing-the-premier-league.md)
### Introduction

View File

@ -6,8 +6,8 @@ information.
We highly recommend checking out the other articles from this series:
* [Analyzing TED Talks](analyzing_TED_talks.md)
* [Exploring the European Road Network](exploring_the_european_road_network.md)
* [Analyzing TED Talks](02_analyzing-TED-talks.md)
* [Exploring the European Road Network](04_exploring-the-european-road-network.md)
### Introduction

View File

@ -6,8 +6,8 @@ information.
We highly recommend checking out the other articles from this series:
* [Analyzing TED Talks](analyzing_TED_talks.md)
* [Graphing the Premier League](graphing_the_premier_league.md)
* [Analyzing TED Talks](02_analyzing-TED-talks.md)
* [Graphing the Premier League](03_graphing-the-premier-league.md)
### Introduction