1
0
Fork 0
Commit Graph

196 Commits

Author SHA1 Message Date
KVS85 ec131ac37d Adjust Documentation to docs repo of 3.5 2019-10-03 21:07:49 +02:00
Simran ef3aeb00e5 Documentation 3.5/example generation improvements (#9498)
* Documentation/switch example generation to rocksdb (#9478)

* improve the formatting of the batch request documentation

* split to linewise, check whether we have a json and format it.

* Add missing asterisk

* Minor fixes / improvements
2019-07-18 14:45:59 +03:00
Frank Celler b55f826ee1 changed to highlight.js 2019-04-22 21:58:08 +02:00
Simran 6a3fa519a2 Doc - Extend generation of program option tables (#7888) 2019-01-10 19:39:26 +01:00
Simran 496ab3af05 Doc - Deprecation notes 3.4 (#6405) 2018-10-23 17:45:07 +02:00
Simran fd1019c51e Doc - Sync external repos 2018-09-26 (#6476) 2018-10-01 18:12:56 +02:00
Simran 5c9cf69bd2 Doc - Configuration refactor 2 (#6378) 2018-09-05 19:39:39 +02:00
Tobias Gödderz a540042445 Doc - ArangoSearch documentation update (#6323) 2018-09-05 18:17:45 +02:00
Wilfried Goesgens 1a4ccf9de8 differenciate between AQL Queries and AQL Explain in generated headlines and buttons (#6311) 2018-08-31 20:09:46 +02:00
Simran 5dee223951 Doc - Automated EE program options (#6228) 2018-08-22 18:26:13 +02:00
Jan 86204ed0b8
fix memory leaks in arangosh connections (#6160) 2018-08-17 08:48:54 +02:00
jsteemann b09638a883 fixthedocs.com 2018-08-14 12:02:53 +02:00
Simon 6a97e441a6 Doc - New section for query profiler + fresh examples (#6070) 2018-08-08 10:51:09 +02:00
Wilfried Goesgens fca40ca87c Doc - improve error handling in case of empty json file (#5832)
* improve error handling in case of empty json file
* fresh examples
* Update generateMdFiles.py
2018-07-11 19:32:09 +02:00
Wilfried Goesgens bd8976956c Doc - Add example anchors (#5752) 2018-07-06 16:19:36 +02:00
maxkernbach 10a2709318 Doc - fix documentation build script + a few other things (#5751) 2018-07-03 18:12:36 +02:00
Simran 0aa1ae24b3 Doc - Take whatever line endings and turn them into LF in generation (#5714) 2018-07-02 15:34:35 +02:00
sleto-it 60bc6a948c
Doc - Dangling interbook checker [New] (#5735) 2018-06-30 13:23:02 +02:00
Wilfried Goesgens 59390ef374 Doc - Improves fetch-script. Fresh Swagger. Sync external repos (#5463) 2018-05-28 16:29:30 +02:00
Simran ab5775c04b Doc - Remove AQL array example anchors (#5207) 2018-05-14 10:29:07 +02:00
Simran 59de3403c1 Doc - Administration & Programs Refactor (#4907) 2018-05-10 13:05:22 +02:00
Wilfried Goesgens 7646d02702 Documentation/re add link (#5241) 2018-05-02 11:09:12 +02:00
Wilfried Goesgens c4b0ccb56f Doc - fix restheader (#5209) 2018-04-27 13:15:42 +02:00
Wilfried Goesgens 13a179304e Doc - Fixes duplicate text in the HTTP doc - Part 1 (#5153)
Fixes the condition when blocks end, so we can pick blocks with empty lines in them
2018-04-20 12:56:14 +02:00
sleto-it 5661492de0
Doc - New Driver Book (#4825) 2018-04-12 17:12:54 +02:00
Manuel B 73b6975e56 Doc - colors in the AQL explain examples (#4835) 2018-03-14 11:55:29 +01:00
Wilfried Goesgens c7a9b41cf5 Doc - Interactively generated AQL examples (#4757)
* interactively generated AQL examples
2018-03-05 19:17:16 +01:00
Wilfried Goesgens bffac3f1f4 fix codeblock reader - keep newlines (#4734)
We must keep newlines when copying the markdown blocks into the documentation; else it will destroy the structure of documents.
fixes #4716
2018-03-02 11:48:11 +01:00
sleto-it 0ba532b16a
Doc - Replication Refactor - Part 1 (#4555)
Next steps after DC2DC and Cluster doc improvements:

- We refactor replication sections and make more intuitive separation between Master/Slave and the new Active Failover in 3.3
- We create corresponding sections for Master/Slave and Active Failover in the Administration and Deployment chapters, as well as in the Scalability chapter, where these "modes" are introduced
- We touch and improve the "Architecture" chapter as well, where some architecture info have to be placed
- We reorg the TOC having in more "logical" order:
-- Deployment
-- Administration
-- Security
-- Monitoring
-- Troubleshooting
- We adds parts in the TOC
- We add toc per pages, using page-toc plugin
- We also put close together "Scalability" and "Architecture" chapters, preliminary steps of further improvements / aggregation
- We improve swagger

Internal Ref:
- https://github.com/arangodb/planning/issues/1692
- https://github.com/arangodb/planning/issues/1655
- https://github.com/arangodb/planning/issues/1858
- https://github.com/arangodb/planning/issues/973 (partial fix)
- https://github.com/arangodb/planning/issues/1498 (partial fix)
2018-02-28 12:23:19 +01:00
Wilfried Goesgens 0b03d08c02 Documentation/fix swagger (#4622) 2018-02-19 18:54:15 +01:00
sleto-it c77b67bcd7
Doc - sync script (#4548)
Include Willi's script to synchronize doc from external repos into our official doc
2018-02-09 10:23:26 +01:00
Wilfried Goesgens 1289804630 add script to seek and destroy removed example files (#4256) 2018-01-09 14:18:51 +01:00
Simran efa75d345c Proper links for new features, correct sitemap URL of Cookbook (#4118)
* Proper links for new features, correct sitemap URL of Cookbook

* Update CSS, remove HEADER.html, remove traces of MDPP
2017-12-21 11:34:05 +01:00
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