From d90715541421bfdcc12691994656f0e97c3a3654 Mon Sep 17 00:00:00 2001 From: Willi Goesgens Date: Tue, 11 Nov 2014 13:12:45 +0100 Subject: [PATCH 1/4] add Documentation index for the Tasks API --- Documentation/Books/Users/HttpTasks/README.mdpp | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 Documentation/Books/Users/HttpTasks/README.mdpp diff --git a/Documentation/Books/Users/HttpTasks/README.mdpp b/Documentation/Books/Users/HttpTasks/README.mdpp new file mode 100644 index 0000000000..f30c2f4424 --- /dev/null +++ b/Documentation/Books/Users/HttpTasks/README.mdpp @@ -0,0 +1,13 @@ +!CHAPTER Http tasks Interface + +Following you have ArangoDB's Http Interface for Tasks. + +There are also some examples provided for every API action. + +@startDocuBlock JSF_get_api_tasks + +@startDocuBlock JSF_post_api_new_tasks + +@startDocuBlock JSF_put_api_new_tasks + +@startDocuBlock JSF_delete_api_tasks From 7f8222c0e65fa9d9a22ffbb5ac15b428cd5ec09f Mon Sep 17 00:00:00 2001 From: Willi Goesgens Date: Tue, 11 Nov 2014 13:38:13 +0100 Subject: [PATCH 2/4] Rename unittest README to maintainers README, add more information. --- README_unittests.md => README_maintainers.md | 85 +++++++++++++++++++- 1 file changed, 83 insertions(+), 2 deletions(-) rename README_unittests.md => README_maintainers.md (64%) diff --git a/README_unittests.md b/README_maintainers.md similarity index 64% rename from README_unittests.md rename to README_maintainers.md index 8471df4dcc..e895aa149e 100644 --- a/README_unittests.md +++ b/README_maintainers.md @@ -1,8 +1,89 @@ + +ArangoDB Maintainers manual +--------------------------- +--------------------------- +--------------------------- +This file contains documentation about the build process, documentation generation means, unittests - put short - if you want to hack parts of arangod this could be interesting for you. + +Configure +--------- +--------- +--enable-relative +--enable-maintainer-mode +--enable-all-in-one-icu +--with-backtrace + +CFLAGS +------ + -DDEBUG_CLUSTER_COMM - Add backtraces to cluster requests so you can easily track their origin + +V8 Special flags: +-DENABLE_GDB_JIT_INTERFACE +(enable (broken) GDB intergation of JIT) +At runtime arangod needs to be started with these options: +--javascript.v8-options="--gdbjit_dump" +--javascript.v8-options="--gdbjit_full" + + +Runtime +------- + * start arangod with --console to get a debug console + * Cheapen startup for valgrind: --no-server --javascript.gc-frequency 1000000 --javascript.gc-interval 65536 --scheduler.threads=1 --javascript.v8-contexts=1 + * to have backtraces output set this on the prompt: ENABLE_NATIVE_BACKTRACES(true) + +Documentation +------------- +------------- +Dependencies: + * swagger + * gitbook + * markdown-pp + * cURL if you want to cut'n'paste execute the examples + +Where... +-------- + - js/action/api/* - markdown comments in source with execution section + - Documentation/Books/Users/SUMMARY.md - index of all sub documentations + - Documentation/Scripts/generateSwaggerApi.py - list of all sections to be adjusted if + +generate +-------- + - make swagger - on toplevel to generate the documentation interactively with the server + - cd Documentation/Books; make - to generate the HTML documentation + +read / use the documentation +---------------------------- + - file:///Documentation/Books/books/Users/index.html contains the generated documentation + - JS-Console - Tools/API - Interactive documentation which you can play with. + + +JSLint +------ +------ +(we switched to jshint a while back - this is still named jslint for historical reasons) + +Make target +----------- +use +make jslint +to find out whether all of your files comply to jslint. This is required to make contineous integration work smoothly. + +if you want to add new / new patterns, edit js/Makefile.files + +Use standalone for your js file +------------------------------- +If you want to search errors in your js file, jslint is very handy - like a compiler is for C/C++. +You can invoke it like this: + +bin/arangosh --jslint js/server/modules/org/arangodb/testing.js + + ArangoDB Unittesting Framework ------------------------------ ------------------------------ ------------------------------- - +Dependencies +------------ + * Ruby, rspec Filename conventions From 22dd153eabe162d36372227ac883d6eab01c6144 Mon Sep 17 00:00:00 2001 From: Thomas Schmidts Date: Tue, 11 Nov 2014 14:10:52 +0100 Subject: [PATCH 3/4] Added links to gitbook and markdown-pp --- README_maintainers.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README_maintainers.md b/README_maintainers.md index e895aa149e..1d80ba46ba 100644 --- a/README_maintainers.md +++ b/README_maintainers.md @@ -36,8 +36,8 @@ Documentation ------------- Dependencies: * swagger - * gitbook - * markdown-pp + * gitbook (https://github.com/GitbookIO/gitbook) + * markdown-pp (https://github.com/triAGENS/markdown-pp) * cURL if you want to cut'n'paste execute the examples Where... From 793e0c547f6def8e75a81ccfb90c0484a9311aaa Mon Sep 17 00:00:00 2001 From: Thomas Schmidts Date: Tue, 11 Nov 2014 14:30:05 +0100 Subject: [PATCH 4/4] Changed www. to docs. in the README.md for documenation links --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8d8908d111..2fb2280275 100644 --- a/README.md +++ b/README.md @@ -70,11 +70,11 @@ More Information ---------------- Please check the -[Installation Manual](https://www.arangodb.com/Installing/README.html) +[Installation Manual](https://docs.arangodb.com/Installing/README.html) for installation and compilation instructions. The -[User Manual](https://www.arangodb.com/FirstSteps/README.html) +[User Manual](https://docs.arangodb.com/FirstSteps/README.html) has an introductory chapter showing the basic operations of ArangoDB. Or you can use the