From c4c22417b9f5bf2f390001ba39eb9b1165fa8144 Mon Sep 17 00:00:00 2001 From: Matej Ferencevic Date: Sat, 7 Oct 2017 22:32:34 +0200 Subject: [PATCH] Added user documentation community bundle script. Reviewers: buda Reviewed By: buda Subscribers: pullbot Differential Revision: https://phabricator.memgraph.io/D878 --- docs/.gitignore | 1 + docs/user_technical/README.md | 3 ++ docs/user_technical/bundle | 35 ----------------- docs/user_technical/bundle_community | 58 ++++++++++++++++++++++++++++ 4 files changed, 62 insertions(+), 35 deletions(-) delete mode 100755 docs/user_technical/bundle create mode 100755 docs/user_technical/bundle_community diff --git a/docs/.gitignore b/docs/.gitignore index 7e3b9c278..be60d87a8 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,5 +1,6 @@ doxygen/html/ doxygen/latex/ +user_technical/.bundle_community/ user_technical/.couscous/ user_technical/couscous.phar user_technical/docs.tar.gz diff --git a/docs/user_technical/README.md b/docs/user_technical/README.md index adebcb4fe..a4917144f 100644 --- a/docs/user_technical/README.md +++ b/docs/user_technical/README.md @@ -6,6 +6,8 @@ Memgraph is an ACID compliant high performance transactional in-memory graph database management system featuring highly concurrent data structures, multi-version concurrency control and asynchronous IO. +[//]: # (When adding a new documentation file, please add it to the list) + ## Contents * [About Memgraph](#about-memgraph) @@ -15,3 +17,4 @@ data structures, multi-version concurrency control and asynchronous IO. * [openCypher Query Language](open-cypher.md) * [Upcoming Features](upcoming-features.md) +[//]: # (Nothing should go below the contents section) diff --git a/docs/user_technical/bundle b/docs/user_technical/bundle deleted file mode 100755 index dc37198b6..000000000 --- a/docs/user_technical/bundle +++ /dev/null @@ -1,35 +0,0 @@ -#!/bin/bash - -working_dir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" - -# curl and php are required -if ! which php >/dev/null; then - echo "php is required!" - exit 1 -fi - -cd ${working_dir} -generator="couscous.phar" - -# download the generator if it's not already downloaded -if [ ! -f ${generator} ]; then - curl -OS http://couscous.io/${generator} -fi - -# generate the site -php ${generator} generate - -# fix paths in generated files -cd .couscous/generated -for i in *; do - if [ ! -f $i ]; then continue; fi - sed -i 's@/css/@/docs/css/@g' $i - sed -i 's@/fonts/@/docs/fonts/@g' $i - sed -r 's@(