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
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