1
0
Fork 0
Commit Graph

28 Commits

Author SHA1 Message Date
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 5c9cf69bd2 Doc - Configuration refactor 2 (#6378) 2018-09-05 19:39:39 +02:00
Simran 5dee223951 Doc - Automated EE program options (#6228) 2018-08-22 18:26:13 +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
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
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 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
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
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
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 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
Wilfried Goesgens 4506a1ee10 Fix RESTHEADER parts. 2016-05-23 17:06:27 +02:00
Wilfried Goesgens 8d31426eb3 Move python scripts into the scripts directory 2015-12-09 00:00:49 +01:00