Wilfried Goesgens
8a5380d767
Add INBOUND/ANY documentation.
2015-11-19 14:19:00 +01:00
Wilfried Goesgens
44df2b0711
Add examples for graph traversals
2015-11-19 14:18:38 +01:00
Wilfried Goesgens
6dd5c8270b
- move aql graph features into a graph topic
...
- add the new traversal
- add new example graphs
2015-11-18 17:38:44 +01:00
Alan Plum
55cf66d875
Fix #1573
2015-11-17 13:22:11 +01:00
Wilfried Goesgens
ad4962657c
add the require command
2015-11-16 09:44:12 +01:00
Frank Celler
e0fa064f72
Merge pull request #1568 from kibarda/devel
...
'application' renamed to 'service' in Web Interface description
2015-11-12 14:00:03 +01:00
Neuchatil
80c11d91f5
'application' renamed to 'service' in Web Interface description
...
application renamed to service in Web Interface description
2015-11-12 12:19:05 +01:00
Wilfried Goesgens
db029a352f
Mention that neighbors() and shortest_path() may return null-items.
2015-11-10 15:29:42 +01:00
Wilfried Goesgens
c97c27ce87
Make the headlines uniq since they're used to construct the anchors.
2015-11-10 15:29:16 +01:00
Jan Steemann
e321c9747a
added option `--server.hide-product-header`
2015-11-10 10:27:59 +01:00
Frank Celler
8d2b6caeed
Merge pull request #1554 from kibarda/patch-1
...
added a subsection Modifying a single document (CLA received)
2015-11-06 11:03:08 +01:00
Wilfried Goesgens
a24be7f782
Capital Foxx!
2015-11-05 15:19:03 +01:00
Wilfried Goesgens
19f6ed6032
Rework HTTP basics
...
- remove mentioning of the long gone ArangoDB 1.4
- swap sequence to first mention keepalive, then using it efficiently with async HTTP requests
- introduce the well known connection pool buzzword and howto use it best with keepalive and async HTTP
- mention in FOXX that this may also be a consideration here
- move the HTTP Basics above the API description
- mention that the user may also want to use the swagger.io interactive API-documentation in his ArangoDB
This answers the question and thus fixes #1533
2015-11-05 13:51:56 +01:00
Jan Steemann
2e8983dc7d
notes on deadlocks and deadlock detection
2015-11-04 17:15:56 +01:00
Wilfried Goesgens
eb75c12bb2
Newer Versions of gitbook put in the source document. Exclude these lines from our sanity checks.
2015-11-03 11:27:59 +01:00
ifcologne
bfea394d94
Typos
2015-11-03 10:21:36 +01:00
Frank Celler
376846c51d
reverted acfb3fd700
because of missing CLA
2015-11-03 10:21:34 +01:00
Frank Celler
e4eff4c16f
reverted 71c37439a8
, 3dbb101b4a
, af6202e3e7
because of missing CLA
2015-11-03 10:21:33 +01:00
Frank Celler
a6a4dc4b85
reverted 34fec84a77
because of missing CLA
2015-11-03 10:21:33 +01:00
jsteemann
b1a95cb42c
added AQL function `UNSET_RECURSIVE`
2015-11-03 10:21:30 +01:00
Neuchatil
5e1b7e5a31
added a subsection Modifying a single document
...
added a subsection Modifying a single document with INSERT, UPDATE, REMOVE examples on single documents
2015-10-30 14:36:36 +01:00
Frank Celler
dc22f0495b
reverted commit because of missing CLA
2015-10-29 19:26:37 +01:00
Michael Hackstein
0869a4d91b
Updated the documentation for arrayindexing with subattributes
2015-10-27 13:51:10 +01:00
Michael Hackstein
e9b858d287
Added handling of null and sparsity in the array index to the documentation
2015-10-27 13:23:38 +01:00
Jan Steemann
025e470e3b
added a single-array parameter variant for the AQL MERGE function
2015-10-23 15:29:53 +02:00
Jan Steemann
fb93c8a7d8
documentation update for indexes
2015-10-23 12:54:00 +02:00
Frank Celler
39cd175a8d
changed full-text to fulltext
2015-10-22 15:41:34 +02:00
Wilfried Goesgens
d1386ef8ee
New examples.
2015-10-22 11:32:40 +02:00
Wilfried Goesgens
877b2d9172
Add notes about the Explainer tool.
2015-10-22 11:31:52 +02:00
Jan Steemann
1447a903e6
note on array indexes
2015-10-21 18:06:09 +02:00
Jan Steemann
becac4b4b1
documentation fixes
2015-10-21 16:14:21 +02:00
Jan Steemann
876b60d109
updated optimizer documentation
2015-10-21 15:48:20 +02:00
Jan Steemann
0d2197e77f
changed documentation for index creation methods
2015-10-21 14:59:45 +02:00
Jan Steemann
b91c6fcdb4
updated documentation
2015-10-21 12:55:35 +02:00
Max Neunhoeffer
d870bc5cb8
Move indexing chapter earlier in manual.
2015-10-15 11:27:47 +02:00
Max Neunhoeffer
5f3a69f3a4
Fixed a typo in the documentation.
2015-10-15 11:27:37 +02:00
Frank Celler
b572db4f19
style guide
2015-10-07 15:54:18 +02:00
Alan Plum
5b7f3d19d0
Deprecate CS in 2.9, not 2.8
2015-10-06 12:47:58 +02:00
CoDEmanX
41d6594246
Documentation formatting
2015-10-02 03:14:55 +02:00
Wilfried Goesgens
f4c68b9dd1
raise an exception if a RESTREPLYBODY is seen before RESTRETURNCODE
2015-10-01 20:09:08 +02:00
Frank Celler
e1575aa11d
removed remark about Micro Instance
2015-10-01 17:45:42 +02:00
Claudius Weinberger
37f52fd42f
Insert a blank
2015-10-01 17:25:08 +02:00
Wilfried Goesgens
160d9a1e53
Two more places to follow General-Graph -> GeneralGraph
2015-10-01 14:48:34 +02:00
Wilfried Goesgens
b66c00f55e
New examples generated by the fixed require mechanism.
2015-10-01 13:30:55 +02:00
Wilfried Goesgens
aa12514b5c
Fix links; currently links in REST-documentation only work in the RESTDESCRIPTION :-(
2015-10-01 13:30:55 +02:00
Jan Steemann
7933fe5d4b
restore 2.6 behavior for db-based modules
2015-10-01 10:51:23 +02:00
Frank Celler
1d95974293
removed out-dated comments
2015-10-01 10:17:19 +02:00
Frank Celler
9d49eb9d05
updated to devel branch
2015-09-29 13:15:41 +02:00
Frank Celler
f8c79f1ab0
added ARANGODB_DEFAULT_ROOT_PASSWORD
2015-09-29 13:15:25 +02:00
Wilfried Goesgens
7513a59b3f
de-escape markdown in anchors.
2015-09-28 17:58:59 +02:00
Wilfried Goesgens
626cd4ffff
Use some more links to the exmaple graphs.
2015-09-28 17:58:32 +02:00
Wilfried Goesgens
c3d587a239
We now return 202 in org/arangodb/actions/echoRequest
2015-09-25 17:00:54 +02:00
Wilfried Goesgens
712a3bcceb
Implement a starting resource for graph documentation
2015-09-24 18:53:23 +02:00
Wilfried Goesgens
3ec86166e8
Fix detection of curl examples
2015-09-24 18:39:53 +02:00
Jan Steemann
4249095456
issue #1507 : added optional *allowImplicit* sub-attribute for transactions
2015-09-24 15:50:00 +02:00
Wilfried Goesgens
a9ea2122d5
Revert 9cd38eba44
again.
2015-09-24 14:09:14 +02:00
Jan
22dd080566
Merge pull request #1498 from thurt/patch-1
...
Remove duplicate "/firstCollection"
2015-09-24 13:00:20 +02:00
Wilfried Goesgens
9cd38eba44
Partially revert 6aabcb99c5
- this http interface is still required for blueprints.
2015-09-23 17:02:42 +02:00
Wilfried Goesgens
6aabcb99c5
Remove deprecated graph documentation.
2015-09-23 14:26:24 +02:00
Wilfried Goesgens
44c2063662
Add information about the graph the samples are querying so the user has a better overview.
2015-09-23 14:12:18 +02:00
Michael Hackstein
52559caa6f
Deleted localstorage used for searching in the docs. This search is not used anymore but still the result was ddisplayed for old searches
2015-09-22 17:22:28 +02:00
Wilfried Goesgens
3af172c8a1
Fix typos, add links to mesos
2015-09-21 16:52:45 +02:00
Wilfried Goesgens
d75bee43b7
Use the same plugin for the index as the docs.arangodb.com does
2015-09-21 16:50:19 +02:00
Wilfried Goesgens
15b1d7cfd5
Migrate sub-structured replies to swagger2 preproc docu style
2015-09-18 17:02:53 +02:00
thurt
acfb3fd700
Remove duplicate "/firstCollection"
...
The code snippets for API calls and cURL examples seem to have an additional "/firstCollection" in the URI.
2015-09-17 22:22:45 -04:00
Wilfried Goesgens
17f1b316dd
Add checker for MarkdownPP failures; fix existing failures ( fixes #1497 )
...
MarkdownPP fails on broken ``` code sections.
2015-09-17 17:26:01 +02:00
Wilfried Goesgens
90aab26866
Add html reply logger
2015-09-17 15:54:27 +02:00
Wilfried Goesgens
a8e0818444
group the routes in the swagger api to get a leaner toplevel index
2015-09-17 15:53:19 +02:00
Wilfried Goesgens
b06d03e84f
Cleanup documentation for remaining @-tags
2015-09-17 11:15:33 +02:00
jsteemann
335e46d222
added generated documentation
2015-09-16 19:59:17 +02:00
jsteemann
0196dc0f51
documentation fixes
2015-09-16 19:58:59 +02:00
Jan Steemann
30aedaad44
fixed replacement of @RESTURLPARAMS
2015-09-16 18:03:23 +02:00
Wilfried Goesgens
70a2c74c1b
Update RESTAPI documentation handling to work with the swagger 2 api
...
- use the structures from the swagger for post / reply structures
- add missing documentation snippets to their respective places
- fix syntax of documentation blocks
2015-09-16 16:35:13 +02:00
Wilfried Goesgens
1db31321e4
Fix http server header
2015-09-16 16:17:26 +02:00
CoDEmanX
f13c2f1fce
Alternative DATE_FORMAT() implementation
2015-09-15 11:43:57 +02:00
jsteemann
80617c8716
updated hash index documentation
2015-09-15 00:16:36 +02:00
jsteemann
22e17814e3
additionally allow the following characters in document keys:
...
`(` `)` `+` `,` `=` `;` `$` `!` `*` `'` `%`
2015-09-15 00:16:08 +02:00
Jan Steemann
72cc037ef3
updated hash index information
2015-09-14 17:45:01 +02:00
Jan Steemann
75ccd7e2cc
fixed incremental sync method
2015-09-14 17:44:12 +02:00
Wilfried Goesgens
5e259f4d14
Fix anchor by using http escaped braces
2015-09-14 14:10:26 +02:00
Jan Steemann
e2b28e842e
issue #1480 : Please mention projection & co. in Doc chapter 12.2 - Returning documents
2015-09-14 13:44:11 +02:00
Jan Steemann
400f3fa7c4
Merge branch 'devel' of https://github.com/arangodb/arangodb into devel
2015-09-14 11:55:46 +02:00
CoDEmanX
4158f7d12b
Add AQL function DATE_DAYS_IN_MONTH(), extend DATE_FORMAT()
...
Conflicts:
js/server/modules/org/arangodb/aql.js
2015-09-14 11:35:04 +02:00
Wilfried Goesgens
0507d6c885
Fix docublock syntax - names mustn't superseede each others.
2015-09-14 11:31:15 +02:00
Wilfried Goesgens
19fb4e18d5
New example.
2015-09-14 11:24:34 +02:00
Wilfried Goesgens
da1f023de6
Generate examples, fix cleanup
2015-09-14 11:22:39 +02:00
Wilfried Goesgens
176b150c46
Implement possibility to add reply grammers via the documentation.
2015-09-14 10:49:28 +02:00
Jan Steemann
1a748b46d0
mention AQL date functions in documentation
2015-09-11 18:51:46 +02:00
Willi Goesgens
8d0d1491f8
Propper highlighting and escaping for examples.
2015-09-11 15:04:55 +02:00
Jan Steemann
03e9fbd1d5
fixed typo
2015-09-11 11:57:48 +02:00
Willi Goesgens
10b42e120e
Fresh examples
2015-09-11 11:36:37 +02:00
Willi Goesgens
9090c83fe1
Add error checks:
...
- duplicate routes
- invalid optionals
2015-09-11 11:24:46 +02:00
CoDEmanX
6fba9c5284
Additional AQL date functions: DATE_DAYOFYEAR, DATE_ISOWEEK, DATE_LEAPYEAR, DATE_QUARTER, DATE_ADD, DATE_SUBTRACT, DATE_DIFF, DATE_COMPARE and DATE_FORMAT.
...
Unit tests incomplete and untested. Behavior of some functions might need adjustments. ISO duration cache needs to be cleared on every AQL query to avoid a memory leak.
Please rebuild Aardvark and see TODOs in code. Also added Windows shortcuts to ignore list.
2015-09-11 06:23:36 +02:00
Jan Steemann
03ae917d94
fixed typo
2015-09-10 17:41:01 +02:00
Jan Steemann
81c54fd64e
fixed documentation issues reported by @CoDEmanX
2015-09-10 17:39:54 +02:00
Willi Goesgens
211b2f083d
Make parameter names <strong>
2015-09-10 16:46:28 +02:00
Willi Goesgens
9214ab08a1
- insert parameters into the place where we found it in the docu
...
- attempt to remove unneccessary br's
2015-09-10 16:22:46 +02:00
Willi Goesgens
116705c85c
move the header of the Example into the example context header
2015-09-10 14:53:55 +02:00
Willi Goesgens
a1f79533b9
make the required-node optional
2015-09-10 13:27:43 +02:00
MrPieces
af258bdf4e
fixed typos
2015-09-10 11:50:58 +02:00
Willi Goesgens
57111245f9
- no tempfiles, work directly on the source files
...
- better handling of sub-structured items
- better error handling in case of structures are broken
2015-09-10 10:56:17 +02:00
Jan Steemann
e221aa3365
Merge pull request #1479 from CoDEmanX/devel
...
Add two missing backticks to unbreak docu blocks
2015-09-10 09:17:32 +02:00
Jan Steemann
f8f0dffca2
updated documentation
2015-09-10 01:38:18 +02:00
Jan Steemann
d4e621eed1
documentation updates
2015-09-10 00:35:28 +02:00
CoDEmanX
b10ea6d48b
Revert markdown changes from space indented blocks to code fencing (to enable syntax highlighting)
2015-09-09 22:12:21 +02:00
Alan Plum
beb4371b17
Added 2.7 info.
2015-09-09 21:26:56 +02:00
Jan Steemann
9a563ef951
Merge branch 'devel' of https://github.com/arangodb/arangodb into devel
2015-09-09 17:53:55 +02:00
Jan Steemann
68c602f7cc
Merge pull request #1478 from CoDEmanX/devel
...
Fix Foxx docs markdown
2015-09-09 17:51:38 +02:00
Jan Steemann
2652eabfc2
created stub file
2015-09-09 17:50:17 +02:00
CoDEmanX
39e106b5cf
Fix Foxx docs markdown
2015-09-09 17:45:26 +02:00
Jan Steemann
f077af1594
Merge branch 'devel' of https://github.com/arangodb/arangodb into devel
2015-09-09 17:43:38 +02:00
Willi Goesgens
e1ae661ae0
Work on multi-dimensional swagger post data
2015-09-09 17:40:51 +02:00
Jan Steemann
8e49eabbf3
updated documentation
2015-09-09 15:23:47 +02:00
Willi Goesgens
eb9e03f3f0
Upgrade the REST-API documentation to to swagger V2.0
...
Wrap lines in examples.
2015-09-09 15:21:18 +02:00
Jan Steemann
a7b51c39da
added tests
2015-09-08 17:34:14 +02:00
CoDEmanX
c46dd9452f
Add headlines to Foxx docs
2015-09-08 02:23:09 +02:00
Jan Steemann
623e0c3be0
small documentation fixes
2015-09-07 09:51:38 +02:00
CoDEmanX
251b471da2
Add docs for Arangob, update its man page
2015-09-05 17:51:11 +02:00
CoDEmanX
8aa78dcb7f
Fix some more typos
2015-09-05 17:18:04 +02:00
CoDEmanX
86d58c241d
Remove doc building readme, fix typos
2015-09-05 03:47:06 +02:00
CoDEmanX
e37920a1fa
Fix markdown, slightly re-organize simple query docs.
2015-09-04 22:48:58 +02:00
Willi Goesgens
343b311fdb
Fix more links.
2015-09-04 11:13:27 +02:00
Willi Goesgens
0f224115bd
Follow moving of import tools
2015-09-04 09:51:39 +02:00
Willi Goesgens
2ba7863592
.md links should be replaced by .html during the processing, if not, they're dangling links.
2015-09-04 09:48:05 +02:00
CoDEmanX
3a9648d78a
More Americanization
2015-09-03 22:25:43 +02:00
Jan Steemann
eb39253b80
updated documentation
2015-09-03 15:14:08 +02:00
Willi Goesgens
c6a69ac781
Add new examples.
2015-09-03 14:57:44 +02:00
Willi Goesgens
11a8b1841b
Restructure Documentation to reduce the number of top list items
...
- combine HTTP-API Bulk interface descriptions and the tools that use them in an new top-level point 'Bulk Import/Export'
- add information about the arangosh db-object implementation
- add information about the arangod db-object implementation (fixes #1223 )
2015-09-03 14:44:45 +02:00
Jan Steemann
d8c83a02b3
don't include bogus files when checking duplicate documentation blocks
2015-09-03 13:07:14 +02:00
Jan Steemann
72ce3ee961
added note
2015-09-03 12:08:31 +02:00
Jan Steemann
285edbfb60
add notes about ARM CPU alignment
2015-09-03 11:49:26 +02:00
CoDEmanX
a39b712efe
Documentation: corrected typos and case, prefer American over British English
2015-09-01 17:19:13 +02:00
CoDEmanX
4088f186ce
Documentation: unify whitespace to spaces
2015-09-01 17:19:12 +02:00
CoDEmanX
46bba6ae9b
Updated list of available test-cases in man pages for arangob
2015-09-01 17:19:10 +02:00
Willi Goesgens
77c97199f2
We need to copy the pngs, else later build steps will only contain possibly invalid symlinks to them.
2015-08-31 14:33:35 +02:00
Jan Steemann
1867d6c4de
added template string generator function `aqlQuery` for generating AQL queries
...
This can be used to generate safe AQL queries with JavaScript parameter
variables or expressions easily:
var name = 'test';
var attributeName = '_key';
var query = aqlQuery`FOR u IN users FILTER u.name == ${name} RETURN u.${attributeName}`;
db._query(query);
2015-08-30 22:32:26 +02:00
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