1
0
Fork 0
Commit Graph

2012 Commits

Author SHA1 Message Date
Jan Steemann 96af0eeaf8 fixed documentation 2015-08-26 17:04:43 +02:00
Willi Goesgens 7445114b3e fix typo 2015-08-26 15:00:28 +02:00
Willi Goesgens dce738ce9c Escape slashes for dos 2015-08-26 11:36:15 +02:00
Willi Goesgens deb1b6d4f1 use portability path dir separator 2015-08-25 18:08:55 +02:00
Willi Goesgens 2c099b8348 Add a js-scripted way to invoke the example generator - for now it needs a running arangod instance. 2015-08-25 17:56:25 +02:00
Jan Steemann 1af238a6d5 added tests for requireFromIncluded 2015-08-25 12:50:58 +02:00
Jan Steemann bbd8a643bd Merge branch 'devel' of https://github.com/arangodb/arangodb into replication 2015-08-24 11:10:01 +02:00
Jan Steemann b08713d768 added tests and documentation 2015-08-24 11:05:26 +02:00
CoDEmanX 23db2af78a Improvements to documentation building
Fix sed parameter error that creates additional files on Windows/Cygwin, support Python 2.6, fix font for deprecated summary entries and add author/description to book.
2015-08-22 04:18:02 +02:00
Willi Goesgens b88a69713c Add missing example 2015-08-21 17:03:16 +02:00
CoDEmanX 183adccbd9 Make version more prominent in documentation
Many ebook readers (and reading apps) generate covers from meta data like the book title. Therefore it makes sense to place the version string there instead of the first paragraph.
2015-08-21 00:18:32 +02:00
Jan Steemann 82ba366eef removed non-existing paths 2015-08-20 20:39:53 +02:00
Jan Steemann bd3449ad1d updated documentation 2015-08-20 20:35:28 +02:00
Willi Goesgens 6b575c96d9 Add the version into the body of the document, since the header isn't rendered into pdf & ebook. 2015-08-20 14:34:25 +02:00
Jan Steemann 6268a20124 Merge branch 'devel' of https://github.com/arangodb/arangodb into devel 2015-08-19 12:56:51 +02:00
Jan Steemann 3d73af7acf added UPSERT 2015-08-19 12:56:41 +02:00
Willi Goesgens 01a1273a87 Merge pull request #1444 from aurelijusb/documentation
Small documentation improvements
2015-08-19 10:23:36 +02:00
Michael Hackstein 527120a3ea Removed outdated documentation, has been replased by a newer version earlier 2015-08-18 16:36:13 +02:00
Michael Hackstein 602c3d0d59 Improved the documentation for Foxx controller 2015-08-18 16:14:39 +02:00
Willi Goesgens 7014a94225 Use highlight.js for the examples 2015-08-17 11:50:35 +02:00
Aurelijus Banelis 3dce622c82 Documentation: How to update edge
From context it was confusing about changing type/edge/field of collection/document/edge.
It is very important to know, how to change edge,
as it is second most used operation in graph database (first is graph traversal).
2015-08-16 19:00:23 +03:00
Willi Goesgens 068459c70c move header of examples out of the python script, lint it. 2015-08-16 17:53:03 +02:00
Aurelijus Banelis 9c075561f4 Documentation: collection.updateByExample can append not only change
From example it was not clear, that old fields are left unchanged.
So it is not confused with replace whole document: replaceByExample
2015-08-16 17:25:27 +03:00
Willi Goesgens f07e146ad4 Handle combination of multiline and hidden lines 2015-08-14 14:59:27 +02:00
Willi Goesgens 4797b81f44 fix creation / copying of static files 2015-08-14 14:46:57 +02:00
Willi Goesgens 98976413b3 make query handling examples more reliable. 2015-08-14 14:45:53 +02:00
Willi Goesgens 6ea2d42b94 handle non-proper terminated docublocks 2015-08-14 14:45:28 +02:00
Willi Goesgens b20b58f62e Enable check-docublocks. 2015-08-13 18:55:17 +02:00
Willi Goesgens 388592b8f7 Hook in stray docuBlocks 2015-08-13 18:54:38 +02:00
Willi Goesgens b94625f476 Add missing version api 2015-08-13 17:17:32 +02:00
Willi Goesgens 10f8e9f5ac add health check documentation. 2015-08-13 17:16:06 +02:00
Willi Goesgens 0486ab8017 Fix check-summary target, and re-enable it 2015-08-13 16:12:57 +02:00
Willi Goesgens 0e4a345128 Hook in stray docublocks from the foxx docuemtation 2015-08-13 16:12:43 +02:00
Willi Goesgens 4d00a556b6 The documentation in 73033a8e8227edead6d0f10ddb32540403b303a4 was moved here. 2015-08-13 16:06:11 +02:00
Willi Goesgens 080ef2ccf0 Work on the check-docublocks target
- include more temporary files from processing
2015-08-13 15:41:32 +02:00
Willi Goesgens 4012a26743 Work on the templating mechanics
- preserve the linebreaks with <br /> for intermediate processing. However, this needs to be removed later on.
  - flip the sequence of @brief and @RESTHEADER so the output makes more sense.
2015-08-13 15:39:06 +02:00
Willi Goesgens 209cbc9768 Move documentation into the source. 2015-08-13 15:37:43 +02:00
Willi Goesgens f6767d1fbd List skipped filenames as a bunch, not one per line. 2015-08-13 14:26:01 +02:00
Willi Goesgens 9fa3ce60c8 Examplify job api 2015-08-13 14:25:05 +02:00
Willi Goesgens ab0c69df30 raise error if a broken URL was specified during creating the example. 2015-08-13 13:07:16 +02:00
Jan Steemann dc1910e331 added AQL optimizer rule `patch-update-statements` 2015-08-13 13:02:47 +02:00
Willi Goesgens adf6fd5321 Fix execution of these examples 2015-08-13 11:50:11 +02:00
Willi Goesgens 52406fa674 Move call documentation over into the source. 2015-08-13 10:49:04 +02:00
Willi Goesgens f5d301a814 Move documentation into the source files. 2015-08-12 17:38:41 +02:00
Willi Goesgens bbb22ef005 de-duplicate documentation also presend in arangod/RestHandler/RestQueryHandler.cpp 2015-08-12 13:28:38 +02:00
Willi Goesgens 1baa500d4a New / old examples. 2015-08-12 11:34:38 +02:00
Willi Goesgens bfab367e3d Examplify docu. 2015-08-12 11:12:15 +02:00
Willi Goesgens c3c6220eeb to make foxx routing return 405 is not easily possible - document the 404 behaviour. 2015-08-12 09:26:00 +02:00
Willi Goesgens da73b7e214 Remove advanced section, its real content is already gone. 2015-08-11 17:03:31 +02:00
Willi Goesgens ec0ff178b6 Fix broken links. 2015-08-11 16:50:27 +02:00
Willi Goesgens 9038aa3da9 Add examples to the query administration. 2015-08-11 16:13:35 +02:00
Willi Goesgens c07ede6230 fix installation procedure for included images. 2015-08-11 16:07:34 +02:00
Willi Goesgens a497797010 fix json syntax by more clever quoting 2015-08-11 14:43:14 +02:00
Willi Goesgens cbcf5cc7fe Fix detection of switch to disable own server for make examples. 2015-08-11 14:21:19 +02:00
Willi Goesgens 695891e46f Merge branch 'devel' of github.com:arangodb/ArangoDB into devel 2015-08-11 14:19:05 +02:00
Jan Steemann e6d11818c9 Merge branch 'devel' of https://github.com/arangodb/arangodb into devel 2015-08-11 14:18:11 +02:00
Willi Goesgens 3bb3d6b623 Work on the documentation to contain real examples. 2015-08-11 14:18:08 +02:00
Jan Steemann 8b28251f58 Merge branch 'devel' of https://github.com/arangodb/arangodb into devel 2015-08-11 14:16:54 +02:00
Willi Goesgens 3c988dc7f1 fix parts of the check-docublocks target to work with the new inline samples.
However, its not yet clean, since its primary conditions still aren't met.
2015-08-11 14:16:28 +02:00
Jan Steemann 68465ebba5 Merge branch 'collection-not-loaded' of https://github.com/arangodb/arangodb into devel
Conflicts:
	js/apps/system/_admin/aardvark/APP/frontend/build/app.js.gz
	js/apps/system/_admin/aardvark/APP/frontend/build/app.min.js
	js/apps/system/_admin/aardvark/APP/frontend/build/app.min.js.gz
	js/apps/system/_admin/aardvark/APP/frontend/build/scripts.html.part
	js/apps/system/_admin/aardvark/APP/frontend/build/standalone-min.html
	js/apps/system/_admin/aardvark/APP/frontend/build/standalone-min.html.gz
	js/apps/system/_admin/aardvark/APP/frontend/build/standalone.html
2015-08-11 14:16:12 +02:00
Willi Goesgens 15b450f13b Output the full path to the file, README.mdpp alone isn't that informative. 2015-08-11 14:15:49 +02:00
Willi Goesgens 76dbe1b8cf execute examples in their complete alphabetical order, regardles of whether they're OUTPUT or RUN 2015-08-11 14:13:53 +02:00
Willi Goesgens 25024d7935 New examples. 2015-08-11 14:10:47 +02:00
Alan Plum 22cb44904e Added engines field to example manifest. 2015-08-11 13:41:04 +02:00
Alan Plum a3b2e1727f More docs. 2015-08-11 13:34:57 +02:00
Alan Plum 5c6484d3ed Deprecated controller.addInjector. 2015-08-11 13:26:32 +02:00
Alan Plum c62573dc5c Updated docs for classes. 2015-08-11 13:26:05 +02:00
Alan Plum 1031a3d4e9 Added optional Foxx deps. 2015-08-11 13:08:06 +02:00
Jan Steemann 434d6167db added configuration option `--database.throw-collection-not-loaded-error` 2015-08-11 12:31:42 +02:00
Willi Goesgens fbe79340d8 Add example howto select ranges of dates. 2015-08-10 10:51:50 +02:00
Willi Goesgens 3f658359c1 Examplify 2015-08-07 11:45:39 +02:00
Willi Goesgens eba829542d Add checks whether inline example replacers fail to snap on the right end 2015-08-07 11:45:07 +02:00
Willi Goesgens b6c045b613 Implement dynamic examples for invoking AQL tutorial 2015-08-06 17:52:57 +02:00
Willi Goesgens a05e0fb246 Smarten example generator 2015-08-06 17:52:36 +02:00
Willi Goesgens 9d4eb0d54a if substituting is in a failure state, output the current version of the text so the user can debug it. 2015-08-06 17:16:07 +02:00
Willi Goesgens 4245817c82 Propper error handling for malformed example tokens 2015-08-06 17:03:40 +02:00
Willi Goesgens 18928ef487 Offer to use an already running server to save time 2015-08-06 16:07:10 +02:00
Willi Goesgens d13be88d53 Examplify the 'Exploring Collections and Documents'-chapter 2015-08-06 15:39:32 +02:00
Willi Goesgens 6fdb550a60 Fix directories & orders 2015-08-06 15:39:19 +02:00
Willi Goesgens b412b4b4de Enable filter to be regexes, so groups of examples can be built. 2015-08-06 15:38:53 +02:00
Willi Goesgens 80a43d30a1 Rework documentation generation process
- remove bot.py, its done now in generateMdFiles.py
  - remove make file target that calls python markdownPP for each file
  - add generateMdFiles.py that now
    - iterates over all files to be processed
    - runs markdownPP as a module for it
    - runs the codeblock replacer
  - sort per book make targets
  - bisect intermediate files into a temporary directory: ppbooks; this simplifies cleaning dramatically.
2015-08-06 13:20:35 +02:00
Willi Goesgens 686dee6671 Implement codeblocks inside of mdpp files. 2015-08-05 13:38:40 +02:00
Willi Goesgens c6521c0b92 accept blanks before auto-code blocks, so we can have indend blocks in markdown. 2015-08-05 10:22:26 +02:00
Willi Goesgens 021d01e4fe Rework index documentation; add more executed examples. 2015-08-04 18:42:44 +02:00
Willi Goesgens 7f2b3c0195 New examples. 2015-08-04 18:42:10 +02:00
hkernbach 2136247ea7 removed wrong comment 2015-08-04 17:30:32 +02:00
Thomas Schmidts 7c9acc155b Changed Version look on smartphones 2015-08-04 14:00:11 +02:00
Willi Goesgens 60c277299d New examples. 2015-08-04 13:45:11 +02:00
Willi Goesgens bd36fa5d43 there is a new module in town to be ignored from the index scan. 2015-08-04 13:43:05 +02:00
Thomas Schmidts 4c7fd533d1 Merge branch 'devel' of https://github.com/arangodb/arangodb into devel 2015-08-04 11:43:15 +02:00
Thomas Schmidts 1ae27459f9 Added Version-number to the documentation 2015-08-04 11:42:03 +02:00
Willi Goesgens db38b4f63a move skiplist documentation back into the source. 2015-08-03 17:34:47 +02:00
Willi Goesgens c9ccb0ce00 Properly generate examples for cap constraints. 2015-08-03 16:50:41 +02:00
Willi Goesgens 1eb340ff25 Handle error of endDocuBlock without previously seeing startDocuBlock 2015-08-03 16:46:31 +02:00
Willi Goesgens 3766ab9f59 de-duplicate documentation of geo-indices. 2015-08-03 14:42:11 +02:00
Thomas Schmidts 71452a3fee Added new Header styles to the documentation 2015-08-03 13:02:58 +02:00
Willi Goesgens 0222af45dc New development mode: generate just one example so you can quicker revalidate the example you're working on. 2015-07-31 16:13:13 +02:00
Willi Goesgens 0d8c9cae8d Elaborate in deeper detail for what to connect us and which details to provide. 2015-07-29 14:08:50 +02:00
Jan Steemann 8685a6a250 documentation for `RETURN DISTINCT` 2015-07-27 11:27:59 +02:00
Jan Steemann ead280afe5 added DISTINCT 2015-07-24 13:19:55 +02:00
Jan Steemann e5dbf725b2 added shorthand notation for attribute names in AQL object literals 2015-07-23 14:24:37 +02:00
Thomas Schmidts 1c5e0e53dc Deleted two startDocuBlock that aren't used anymore 2015-07-22 11:27:16 +02:00
Jan Steemann 7d97e874c9 issue #1404: Sorting with different sort directions and skiplist not possible
Trying to clarify documentation on sort clauses
2015-07-21 17:52:59 +02:00
Jan Steemann 20c96b5e46 removed locks 2015-07-21 17:34:57 +02:00
kevin cloinger af6202e3e7 added Configuration
Added a section with examples of how to use configuration from the cli.
2015-07-14 09:43:41 -06:00
Thomas Schmidts 32c1a4ee5d Changed the design of the header in the documentation 2015-07-13 16:57:30 +02:00
Thomas Schmidts c039658f9b Changed the plugin for toggle chapters 2015-07-13 16:56:26 +02:00
Jan Steemann 14ccfbabc3 Merge branch 'aql-query-cache' of https://github.com/arangodb/arangodb into devel 2015-07-13 12:46:41 +02:00
Jan Steemann 5a453bbcfc issue #1409: Document values with null character truncated with 2.6.2 on Windows 2015-07-13 12:45:13 +02:00
Jan Steemann fb85010b10 updated documentation 2015-07-13 10:55:57 +02:00
Jan Steemann c71dc4d9bb Merge branch 'devel' of https://github.com/arangodb/arangodb into aql-query-cache 2015-07-13 10:49:14 +02:00
Willi Goesgens 9899ddf03c Add recommendations about using date time in collections; fixes #1400 2015-07-03 09:30:14 +02:00
Alan Plum ea9e628beb Tense. 2015-07-01 19:06:19 +02:00
Alan Plum 544cabe939 Removed assets from docs. 2015-07-01 17:03:14 +02:00
Alan Plum aa9be8d919 Fixed minor typo. 2015-06-29 01:29:38 +02:00
Jan Steemann 1f5e047486 query cache, now with result limitations, HTTP and JavaScript APIs 2015-06-27 01:12:32 +02:00
Jan Steemann 288cabc3a4 removed reference to non-existing config option 2015-06-25 07:48:23 +02:00
Alan Plum 4e9679d548 Formatting. 2015-06-22 16:47:07 +02:00
Alan Plum 7073b7c18f Added support for repeating jobs. 2015-06-22 16:47:07 +02:00
Thomas Schmidts ce43e1431e Changed path in the codeblockreader for the documentation 2015-06-22 14:38:51 +02:00
Alan Plum 7362331164 Added config type 'password' in manifest. 2015-06-22 14:16:25 +02:00
Jan Steemann 7161e92049 added comment 2015-06-18 15:53:33 +02:00
Thomas Schmidts 4cd7ea3f6f Changed readable folders for documentation 2015-06-18 15:45:48 +02:00
Jan Steemann 3da82bbf3d updated documentation 2015-06-18 15:01:34 +02:00
Jan Steemann 6b8870098b updated documentation 2015-06-18 14:50:50 +02:00
Jan Steemann c45e0dd751 updated documentation 2015-06-18 14:46:38 +02:00
Jan Steemann 5001d0ce86 fixed documentation 2015-06-18 14:36:21 +02:00
Jan Steemann 6bed3a06a9 somehow the previous commit messed it up. try fixing it 2015-06-18 14:22:35 +02:00
Jan Steemann dcfe29211a updated CHANGELOG 2015-06-18 14:03:31 +02:00
Michael Hackstein 0858dce805 Updated documentation and changes for graph features 2015-06-18 09:47:54 +02:00
Jan Steemann d16d8b68c2 simplified example 2015-06-17 22:34:14 +02:00
Jan Steemann 8ff84f1475 fix upgrading notices 2015-06-17 22:10:45 +02:00
Jan Steemann affd2d3d7b removed deprecated AQL function `SKIPLIST` 2015-06-17 20:44:44 +02:00
Jan Steemann eebce71578 deprecated AQL SKIPLIST function 2015-06-17 20:24:14 +02:00
Alan Plum a4af1dc2e2 sessionStorageApp -> sessionStorage 2015-06-17 18:59:03 +02:00
Thomas Schmidts 54c0e0cd21 Removed Foxx Apps from the documentation 2015-06-17 17:20:32 +02:00
Alan Plum fc15d421d6 Implemeneted JSON configs. Cleaned up optional configs. 2015-06-16 17:58:38 +02:00
Alan Plum f428d047cb Allow optional configs. 2015-06-16 16:45:47 +02:00
Alan Plum 1210ee8858 Removed Foxx queue exports warmup workaround. 2015-06-16 15:59:26 +02:00
Alan Plum 6e9900c462 Deprecated sessions options jwt and type. 2015-06-16 14:26:37 +02:00
Jan Steemann afd631f138 issue #1375: mention `SORT null` another time 2015-06-15 15:44:36 +02:00
Thomas Schmidts 047450b98d Changed the order in the Summary of the documentation 2015-06-12 16:50:15 +02:00
Jan Steemann ab4e7e3dad fixed broken documentation 2015-06-12 16:09:03 +02:00
Jan Steemann 9df0c002cd issue #1372: fixed wrong parameter in traversal documentation 2015-06-12 16:08:41 +02:00
Willi Goesgens ab9a16332a Our repo no longer lives under TriAgens, but rather ArangoDB. 2015-06-11 15:58:28 +02:00
Alan Plum a2135e5240 More descriptive chapter title. 2015-06-10 15:27:36 +02:00
Alan Plum a7a1ca2e00 More fixing of the queues. 2015-06-10 14:17:33 +02:00
Alan Plum 584dfdbb5d Upgrade info for queues. 2015-06-09 13:56:10 +02:00
Alan Plum 96822f1c41 More changes. 2015-06-09 13:32:00 +02:00
Michael Hackstein 0c524ae537 Merge branch 'devel' of github.com:/arangodb/arangodb into devel 2015-06-09 11:57:35 +02:00