From 46581bfc9423b6fd6958c66194f9609fe3c8b4d6 Mon Sep 17 00:00:00 2001 From: Teon Banek Date: Tue, 6 Jun 2017 12:03:45 +0200 Subject: [PATCH] Setup a basic skeleton for Technical Documentation Reviewers: buda, dtomicevic Reviewed By: buda Subscribers: pullbot Differential Revision: https://phabricator.memgraph.io/D427 --- docs/user_technical/README.md | 16 +++++++++++----- docs/user_technical/couscous.yml | 2 ++ docs/user_technical/installation.md | 8 ++++++++ docs/user_technical/interfaces.md | 7 +++++++ docs/user_technical/open-cypher.md | 3 +++ docs/user_technical/quick-start.md | 4 ++++ docs/user_technical/upcoming-features.md | 3 +++ 7 files changed, 38 insertions(+), 5 deletions(-) create mode 100644 docs/user_technical/couscous.yml create mode 100644 docs/user_technical/installation.md create mode 100644 docs/user_technical/interfaces.md create mode 100644 docs/user_technical/open-cypher.md create mode 100644 docs/user_technical/quick-start.md create mode 100644 docs/user_technical/upcoming-features.md diff --git a/docs/user_technical/README.md b/docs/user_technical/README.md index 445906234..b7a23884e 100644 --- a/docs/user_technical/README.md +++ b/docs/user_technical/README.md @@ -1,11 +1,17 @@ -# Memgraph End User Techical Documentation +# Technical Documentation + +## About Memgraph Memgraph is an ACID compliant high performance transactional distributed in-memory graph database featuring runtime native query compiling, lock free data structures, multi-version concurrency control and asynchronous IO. -Run command: -``` -docker run -p 7687:7687 memgraph -``` +## Contents + + * [About Memgraph](#about-memgraph) + * [Installation](installation.md) + * [Quick Start](quick-start.md) + * [openCypher Query Language](open-cypher.md) + * [Interfacing with Memgraph](interfaces.md) + * [Upcoming Features](upcoming-features.md) diff --git a/docs/user_technical/couscous.yml b/docs/user_technical/couscous.yml new file mode 100644 index 000000000..f8b838b21 --- /dev/null +++ b/docs/user_technical/couscous.yml @@ -0,0 +1,2 @@ +title: Memgraph +subTitle: Technical Documentation diff --git a/docs/user_technical/installation.md b/docs/user_technical/installation.md new file mode 100644 index 000000000..4a328776a --- /dev/null +++ b/docs/user_technical/installation.md @@ -0,0 +1,8 @@ +## Installation + +Run command: +``` +docker run -p 7687:7687 memgraph +``` + +Proceed to [Quick Start](quick-start.md). diff --git a/docs/user_technical/interfaces.md b/docs/user_technical/interfaces.md new file mode 100644 index 000000000..9f70cb630 --- /dev/null +++ b/docs/user_technical/interfaces.md @@ -0,0 +1,7 @@ +## Interfacing with Memgraph + +Describe all supported interfaces: + + * bolt and + * web browser. + diff --git a/docs/user_technical/open-cypher.md b/docs/user_technical/open-cypher.md new file mode 100644 index 000000000..3ce6f949c --- /dev/null +++ b/docs/user_technical/open-cypher.md @@ -0,0 +1,3 @@ +## openCypher Query Language + +Details about openCypher diff --git a/docs/user_technical/quick-start.md b/docs/user_technical/quick-start.md new file mode 100644 index 000000000..381d015d6 --- /dev/null +++ b/docs/user_technical/quick-start.md @@ -0,0 +1,4 @@ +## Quick Start + +Simplest workflow after installation, querying the database... + diff --git a/docs/user_technical/upcoming-features.md b/docs/user_technical/upcoming-features.md new file mode 100644 index 000000000..23c60570f --- /dev/null +++ b/docs/user_technical/upcoming-features.md @@ -0,0 +1,3 @@ +## Upcoming Features + +List of upcoming features...