Wilfried Goesgens
fbfd3491fb
Documentation/migrate cookbook devel 32 ( #3290 )
...
* migrate the Cookbook into the ArangoDB core repository
* make cookbook links local
2017-09-20 13:40:50 +02:00
Wilfried Goesgens
2646ea2ad1
Migrate documentation build process to pure bash. ( #2619 )
...
* Migrate documentation build process to pure bash.
- the old makefile contained multiple shell snippets which were hard to maintain
- Convert it from Makefile to pure bash build.sh
- Fix error reporting in companion python scripts
- adjust README_maintainers.md to the new script
- provide wrapper GNUMakefile for automatic jobs for compatibility
- use the new shellscript inside the docker wrapper
- use the systems available processors inside the docker container if we build arangod
- strive to build enterprise binaries, since some examples require it.
* fix wrapper makefile
2017-06-21 14:34:17 +02:00
Alan Plum
5d017d733c
Improve Foxx cluster resilience ( #2479 )
...
* Improve Foxx cluster resilience
Fixes #2083
Fixes #2384
Fixes #2408
Addresses #1892
* Port old Foxx API
* Implement single-file services
* Add console.errorStack/warnStack/infoStack helpers
* Simplify serviceInfo validation
* Extract github/upload logic into Aardvark and old FM API
* Move generator logic into Aardvark
* Move zip/js buffer logic into FM core
* Add Foxxmanager tests
* Send empty response when no README
* Disambiguate script arg format
Historically we allow passing an array of positional arguments or an arbitrary first argument.
This is surprising behaviour, so we should just always treat the value as a first argument.
* Rebuild bundle in development mode
* Nicer HTTP docs formatting
* Create Foxx HTTP docs
* Simplify service upload handling
* Remove inline swagger docs
* Implement public download route
* Consistency
* Rebuild aardvark
* Move bundle route into /_api/foxx/_local
* Rebuild Swagger API docs
* Add changes to CHANGELOG
* More docs
2017-05-16 17:41:29 +02:00
Wilfried Goesgens
8b5d557ff7
one more place to rename the include
2017-05-08 11:14:53 +02:00
Simran Brucherseifer
5be45ce513
Docs: remove remaining mdpp bits. Copying files is still needed for examples and docublocks
2017-05-05 10:22:15 +02:00
Wilfried Goesgens
81be8b9901
rename .mdpp files to .md so the handling is easier.
2017-05-04 12:04:24 +02:00
Wilfried Goesgens
cb1efe12dd
colorize warnings/errors for better readability
2017-03-24 17:47:02 +01:00
Wilfried Goesgens
0ed862b58b
add a way to specify excepted return codes
2017-03-15 11:23:24 +01:00
Wilfried Goesgens
8a8e104ca4
raise an error if setup/cleanup calls don't work
2017-03-15 10:45:15 +01:00
Simran Brucherseifer
e4eeb57e30
Docs: Use standard Markdown notation for headlines and disable MarkdownPP
2016-12-06 02:41:58 +01:00
Wilfried Goesgens
d2baa077d0
Fix the representation of the post bodys; thanks to @janavolkova9 for pointing out.
2016-08-01 12:25:37 +02:00
Simran Brucherseifer
963066e42d
Replace more require('internal') by require('@arangodb') where possible
2016-07-27 14:44:17 +02:00
Simran Brucherseifer
4b6e84080b
Swagger: change the way attribute types are written into the docs
...
Code in generateMdFiles.py seems to be not used and could probably be removed.
2016-07-18 13:37:48 +02:00
Simran Brucherseifer
90aaf2aed1
Match inline docublocks non-greedy and prevent name collisions by expecting a whitespace character after block name
2016-07-18 12:15:35 +02:00
Alan Plum
9375d49c8c
Nicer error docs
2016-06-17 20:02:24 +02:00
Wilfried Goesgens
cf0203ceea
Add linebreak in list items.
2016-06-13 18:41:12 +02:00
Wilfried Goesgens
a38e61e1e5
Also output the names of errors.
2016-06-13 18:36:34 +02:00
Wilfried Goesgens
9684f192db
Fix pasting of swagger documentation
2016-06-13 18:18:14 +02:00
Simran Brucherseifer
23e22f6f39
Rename Users documentation to Manual
2016-05-24 16:09:21 +02:00
Wilfried Goesgens
4506a1ee10
Fix RESTHEADER parts.
2016-05-23 17:06:27 +02:00
Wilfried Goesgens
0b4f5c1c8e
Move template files into the general template directory.
2016-05-23 15:46:55 +02:00
Simran Brucherseifer
9645e164f6
Documentation building: also make other scripts aware of additional gitbooks
2016-05-02 20:29:47 +02:00
Frank Celler
f6a833ac5d
added generateSwagger
2016-03-17 14:40:09 +01:00
Frank Celler
e0bb505dda
fixed generateExample
2016-03-17 12:00:27 +01:00
Jan Steemann
b1988c94b8
reduce variance in generated man pages
2016-02-25 13:48:50 +01:00
Frank Celler
fb8965d4b7
fixed manual pages
2016-02-24 19:56:47 +01:00
Frank Celler
48e39567fc
fixed man page generation
2016-02-23 21:28:14 +01:00
Wilfried Goesgens
5b5517b8ab
Fix error message for exception.
2016-02-10 15:53:15 +01:00
Wilfried Goesgens
d2f8021d8e
make examples is history now.
2016-02-10 11:21:08 +01:00
Wilfried Goesgens
7da8a09e37
Fix traversing of DocuBlocks directory.
2016-01-12 19:04:55 +01:00
Wilfried Goesgens
5e5b0de5b2
Adjust directories to spider.
2016-01-12 18:23:12 +01:00
Wilfried Goesgens
a963cfcf8a
`make swagger` now runs on all files in the Documentation/DocuBlocks/Rest
2016-01-12 15:15:14 +01:00
Wilfried Goesgens
623eb02bec
Accept linebreaks in the expectError()
2016-01-07 12:58:23 +01:00
Alan Plum
8853ede355
org/arangodb -> @arangodb
2015-12-15 15:51:44 +01:00
Wilfried Goesgens
8d31426eb3
Move python scripts into the scripts directory
2015-12-09 00:00:49 +01:00
Wilfried Goesgens
8f10c2b8a1
Generate markdown from the restdescritpion instead of html.
2015-12-08 23:47:18 +01:00
Jan Steemann
b8b9956acc
added extra edges handler
2015-12-03 13:11:03 +01:00
Jan Steemann
c053c78e51
update swagger file locations
2015-12-03 13:08:43 +01:00
Wilfried Goesgens
f4c68b9dd1
raise an exception if a RESTREPLYBODY is seen before RESTRETURNCODE
2015-10-01 20:09:08 +02:00
Wilfried Goesgens
a9ea2122d5
Revert 9cd38eba44
again.
2015-09-24 14:09:14 +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
15b1d7cfd5
Migrate sub-structured replies to swagger2 preproc docu style
2015-09-18 17:02:53 +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
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
176b150c46
Implement possibility to add reply grammers via the documentation.
2015-09-14 10:49:28 +02:00
Willi Goesgens
8d0d1491f8
Propper highlighting and escaping for examples.
2015-09-11 15:04:55 +02:00
Willi Goesgens
9090c83fe1
Add error checks:
...
- duplicate routes
- invalid optionals
2015-09-11 11:24:46 +02:00
Willi Goesgens
211b2f083d
Make parameter names <strong>
2015-09-10 16:46:28 +02:00