1
0
Fork 0
Commit Graph

5 Commits

Author SHA1 Message Date
Simran Brucherseifer 861fc167ed Remove (hopefully unnecessary) extra line breaks 2019-11-25 19:23:25 +01:00
Simran Brucherseifer d8c4bb81bf More double LFs, typos 2019-11-25 16:28:34 +01:00
Michael Hackstein 838e91bbe0
Documentation/improve gharial documentation (#6782)
* Minor update to gharial list call

* Updated documentation for graph creation API

* Updated graph get documentation

* Added a section for Query Parameters in Graph Create

* Improved gharial drop documentation

* Added ReturnBodies for graph creation results

* Added the response object description to graph list

* Minor typo

* Added response bodies to graph get documentation.

* Added Response Body documentation on Graph grop

* Added HTTP documentation for add graph vertex collection

* Added dots to finish one-line API description sentences.

* ReplyBodyNames have to be globally unique 😢

* Documented ResponseBodies for vertex-collection-add

* Documented ResponseBodies for vertex-collection-remove

* Added result bodies for create vertex in graph documentation

* started to extract structure in separate file

* Fixed orphan structure reference

* Reuse the same documentation structore in all Graph APIs

* Documented list edge collections in GraphAPI

* Unified vertex representation

* Documented edge definition creation API

* Documented modification of edge definition

* fix support for external structure definitions

* Unified edge definition struct

* Added documentation code for vertex CRUD in Gharial

* Removed unused struct in GraphRestDocu

* Added documentation for edge CRUD in gharial. Fixed wording in vertex CRUD part

* Added missing dots at end of sentences

* MOre dots at end of sentences

* Removed empty lines

* Fixed missing edge_definition remove documentation

* Fixed a typo
2018-10-11 15:18:11 +02:00
Wilfried Goesgens c4b0ccb56f Doc - fix restheader (#5209) 2018-04-27 13:15:42 +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