diff --git a/Documentation/Books/SUMMARY.md b/Documentation/Books/SUMMARY.md deleted file mode 100644 index b380e79635..0000000000 --- a/Documentation/Books/SUMMARY.md +++ /dev/null @@ -1,221 +0,0 @@ -# Summary - -* [Installing](Installing/README.md) - * [Linux](Installing/Linux.md) - * [Mac OS X](Installing/MacOSX.md) - * [Windows](Installing/Windows.md) - * [Compiling](Installing/Compiling.md) - -* [First Steps](FirstSteps/README.md) - * [Getting Familiar](FirstSteps/GettingFamiliar.md) - * [The ArangoDB Server](FirstSteps/Arangod.md) - * [The ArangoDB Shell](Arangosh/README.md) - * [Shell Output](Arangosh/Output.md) - * [Configuration](Arangosh/Configuration.md) - * [Details](FirstSteps/Arangosh.md) - * [Collections](FirstSteps/CollectionsAndDocuments.md) - -* [ArangoDB Web Interface](WebInterface/README.md) - * [Some Features](WebInterface/Features.md) - -* [Handling Databases](Databases/README.md) - * [Working with Databases](Databases/WorkingWith.md) - * [Notes about Databases](Databases/Notes.md) - -* [Handling Collections](Collections/README.md) - * [Collection Methods](Collections/CollectionMethods.md) - * [Database Methods](Collections/DatabaseMethods.md) - -* [Handling Documents](Documents/README.md) - * [Address and ETag](Documents/DocumentAddress.md) - * [Collection Methods](Documents/DocumentMethods.md) - * [Database Methods](Documents/DatabaseMethods.md) - -* [Handling Edges](Edges/README.md) - -* [Simple Queries](SimpleQueries/README.md) - * [Geo Queries](SimpleQueries/GeoQueries.md) - * [Fulltext Queries](SimpleQueries/FulltextQueries.md) - * [Pagination](SimpleQueries/Pagination.md) - * [Sequential Access](SimpleQueries/Access.md) - * [Modification Queries](SimpleQueries/ModificationQueries.md) - -* [Transactions](Transactions/README.md) - * [Transaction invocation](Transactions/TransactionInvocation.md) - * [Passing parameters](Transactions/Passing.md) - * [Locking and isolation](Transactions/LockingAndIsolation.md) - * [Durability](Transactions/Durability.md) - * [Limitations](Transactions/Limitations.md) - -* [AQL](Aql/README.md) - * [How to invoke AQL](Aql/Invoke.md) - * [Query Results](Aql/QueryResults.md) - * [Language Basics](Aql/Basics.md) - * [Operators](Aql/Operators.md) - * [High level Operations](Aql/Operations.md) - * [Graph Operations](Aql/GraphOperations.md) - * [Advanced Features](Aql/Advanced.md) - -* [Extending AQL](AqlExtending/README.md) - * [Conventions](AqlExtending/Conventions.md) - * [Registering Functions](AqlExtending/Functions.md) - -* [AQL Examples](AqlExamples/README.md) - * [Examples](AqlExamples/Examples.md) - * [Collection based queries](AqlExamples/CollectionQueries.md) - * [Projections and filters](AqlExamples/ProjectionsAndFilters.md) - * [Joins](AqlExamples/Join.md) - * [Grouping](AqlExamples/Grouping.md) - -* [Blueprint Graphs](Blueprint-Graphs/README.md) - * [Graph Constructor](Blueprint-Graphs/GraphConstructor.md) - * [Vertex Methods](Blueprint-Graphs/VertexMethods.md) - * [Edge Methods](Blueprint-Graphs/EdgeMethods.md) - -* [General Graphs](General-Graphs/README.md) - * [Functions](General-Graphs/GeneralGraphFunctions.md) - * [Fluent Query Interface](General-Graphs/FluentAQLInterface.md) - -* [Traversals](Traversals/README.md) - * [Starting from Scratch](Traversals/StartingFromScratch.md) - * [Using Traversal Objects](Traversals/UsingTraversalObjects.md) - * [Example Data](Traversals/ExampleData.md) - -* [Foxx](Foxx/README.md) - * [Handling Request](Foxx/HandlingRequest.md) - * [Manifest](Foxx/FoxxManifest.md) - * [FoxxController](Foxx/FoxxController.md) - * [FoxxModel](Foxx/FoxxModel.md) - * [FoxxRepository](Foxx/FoxxRepository.md) - * [Developing Applications](Foxx/DevelopingAnApplication.md) - * [Deploying Applications](Foxx/DeployingAnApplication.md) - * [Optional Functionality](Foxx/FoxxOptional.md) - -* [Foxx Manager](FoxxManager/README.md) - * [First Steps](FoxxManager/FirstSteps.md) - * [Behind the scenes](FoxxManager/BehindTheScenes.md) - * [Multiple Databases](FoxxManager/MultipleDatabases.md) - * [Foxx Applications](FoxxManager/ApplicationsAndReplications.md) - * [Manager Commands](FoxxManager/ManagerCommands.md) - * [Frequently Used Options](FoxxManager/FrequentlyUsedOptions.md) - -* [ArangoDB's Actions](ArangoActions/README.md) - -* [Replication](Replication/README.md) - * [Components](Replication/Components.md) - * [Example Setup](Replication/ExampleSetup.md) - * [Replication Limitations](Replication/Limitations.md) - * [Replication Overhead](Replication/Overhead.md) - * [Replication Events](Replication/Events.md) - -* [Sharding](Sharding/README.md) - * [How to try it out](Sharding/HowTo.md) - * [Implementation](Sharding/StatusOfImplementation.md) - * [Authentication](Sharding/Authentication.md) - * [Firewall setup](Sharding/FirewallSetup.md) - -* [Configure ArangoDB](ConfigureArango/README.md) - * [General options](ConfigureArango/GeneralOptions.md) - * [Arangod options](ConfigureArango/Arangod.md) - * [Endpoints options](ConfigureArango/Endpoint.md) - * [Development options](ConfigureArango/Development.md) - * [Cluster options](ConfigureArango/Cluster.md) - * [Logging options](ConfigureArango/Logging.md) - * [Communication options](ConfigureArango/Communication.md) - * [Random numbers](ConfigureArango/RandomNumbers.md) - * [Authentication](ConfigureArango/Authentication.md) - * [Emergency Console](ConfigureArango/EmergencyConsole.md) - -* [Arangoimp](Arangoimp/README.md) - -* [Arangodump](Arangodump/README.md) - -* [Arangorestore](Arangorestore/README.md) - -* [HTTP API](HttpApi/README.md) - * [Databases](HttpDatabase/README.md) - * [To-Endpoint](HttpDatabase/DatabaseEndpoint.md) - * [Management](HttpDatabase/DatabaseManagement.md) - * [Managing (http)](HttpDatabase/ManagingDatabasesUsingHttp.md) - * [Note on Databases](HttpDatabase/NotesOnDatabases.md) - * [Documents](HttpDocument/README.md) - * [Address and ETag](HttpDocument/AddressAndEtag.md) - * [Working with](HttpDocument/WorkingWithDocuments.md) - * [Edges](HttpEdge/README.md) - * [Address and ETag](HttpEdge/AddressAndEtag.md) - * [Working with Edges](HttpEdge/WorkingWithEdges.md) - * [AQL Query Cursors](HttpAqlQueryCursor/README.md) - * [Query Results](HttpAqlQueryCursor/QueryResults.md) - * [Accessing Cursors](HttpAqlQueryCursor/AccessingCursors.md) - * [AQL Queries](HttpAqlQuery/README.md) - * [AQL User Functions Management](HttpAqlUserFunctions/README.md) - * [Simple Queries](HttpSimpleQuery/README.md) - * [Collections](HttpCollection/README.md) - * [Address](HttpCollection/Address.md) - * [Creating](HttpCollection/Creating.md) - * [Getting Information](HttpCollection/Getting.md) - * [Modifying](HttpCollection/Modifying.md) - * [Indexes](HttpIndexes/README.md) - * [Address of an Index](HttpIndexes/Address.md) - * [Working with Indexes](HttpIndexes/WorkingWith.md) - * [Cap Constraints](HttpIndexes/Cap.md) - * [Hash](HttpIndexes/Hash.md) - * [Skiplist](HttpIndexes/Skiplist.md) - * [Geo](HttpIndexes/Geo.md) - * [Fulltext](HttpIndexes/Fulltext.md) - * [Transactions](HttpTransaction/README.md) - * [Graphs](HttpGraphs/README.md) - * [Vertex](HttpGraphs/Vertex.md) - * [Edges](HttpGraphs/Edge.md) - * [Traversals](HttpTraversal/README.md) - * [Replication](HttpReplications/README.md) - * [Replication Dump](HttpReplications/ReplicationDump.md) - * [Replication Logger](HttpReplications/ReplicationLogger.md) - * [Replication Applier](HttpReplications/ReplicationApplier.md) - * [Other Replications](HttpReplications/OtherReplication.md) - * [Bulk Imports](HttpBulkImports/README.md) - * [JSON Documents](HttpBulkImports/ImportingSelfContained.md) - * [Headers and Values](HttpBulkImports/ImportingHeadersAndValues.md) - * [Edge Collections](HttpBulkImports/ImportingIntoEdges.md) - * [Batch Requests](HttpBatchRequest/README.md) - * [Monitoring](HttpAdministrationAndMonitoring/README.md) - * [User Management](HttpUserManagement/README.md) - * [Async Result](HttpAsyncResultsManagement/README.md) - * [Management](HttpAsyncResultsManagement/ManagingAsyncResults.md) - * [Endpoints](HttpEndpoints/README.md) - * [Sharding](HttpShardingInterface/README.md) - * [Miscellaneous functions](HttpMiscellaneousFunctions/README.md) - * [General Handling](GeneralHttp/README.md) - -* [Javascript Modules](ModuleJavaScript/README.md) - * [Common JSModules](ModuleJavaScript/JSModules.md) - * [Path](ModuleJavaScript/ModulesPath.md) - * ["console"](ModuleConsole/README.md) - * ["fs"](ModuleFs/README.md) - * ["graph"](ModuleGraph/README.md) - * [Graph Constructors](ModuleGraph/GraphConstructor.md) - * [Vertex Methods](ModuleGraph/VertexMethods.md) - * [Edge Methods](ModuleGraph/EdgeMethods.md) - * ["actions"](ModuleActions/README.md) - * ["planner"](ModulePlanner/README.md) - * [Using jsUnity](UsingJsUnity/README.md) - -* [Administrating ArangoDB](AdministratingArango/README.md) - -* [Handling Indexes](IndexHandling/README.md) - * [Cap Constraint](IndexHandling/Cap.md) - * [Geo Indexes](IndexHandling/Geo.md) - * [Fulltext Indexes](IndexHandling/Fulltext.md) - * [Hash Indexes](IndexHandling/Hash.md) - * [Skip-Lists](IndexHandling/Skiplist.md) - * [BitArray Indexes](IndexHandling/BitArray.md) - -* [Datafile Debugger](DatafileDebugger/README.md) - -* [Naming Conventions](NamingConventions/README.md) - * [Database Names](NamingConventions/DatabaseNames.md) - * [Collection Names](NamingConventions/CollectionNames.md) - * [Document Keys](NamingConventions/DocumentKeys.md) - * [Attribute Names](NamingConventions/AttributeNames.md) - -* [Error codes and meanings](ErrorCodes/README.md) diff --git a/Documentation/Books/Users/SUMMARY.md b/Documentation/Books/Users/SUMMARY.md index c2f017ef5c..702474347d 100644 --- a/Documentation/Books/Users/SUMMARY.md +++ b/Documentation/Books/Users/SUMMARY.md @@ -6,7 +6,7 @@ * [Windows](Installing/Windows.md) * [Compiling](Installing/Compiling.md) * [Upgrading in general](Installing/Upgrading.md) - * [Set up Cluster](Installing/Cluster.md) + * [Set up Cluster](Installing/Cluster.md) * [First Steps](FirstSteps/README.md) * [Getting Familiar](FirstSteps/GettingFamiliar.md) @@ -18,36 +18,36 @@ * [Collections](FirstSteps/CollectionsAndDocuments.md) * [ArangoDB Web Interface](WebInterface/README.md) - * [Some Features](WebInterface/Features.md) + * [Some Features](WebInterface/Features.md) * [Handling Databases](Databases/README.md) - * [Working with Databases](Databases/WorkingWith.md) - * [Notes about Databases](Databases/Notes.md) + * [Working with Databases](Databases/WorkingWith.md) + * [Notes about Databases](Databases/Notes.md) * [Handling Collections](Collections/README.md) - * [Collection Methods](Collections/CollectionMethods.md) - * [Database Methods](Collections/DatabaseMethods.md) + * [Collection Methods](Collections/CollectionMethods.md) + * [Database Methods](Collections/DatabaseMethods.md) * [Handling Documents](Documents/README.md) - * [Address and ETag](Documents/DocumentAddress.md) - * [Collection Methods](Documents/DocumentMethods.md) - * [Database Methods](Documents/DatabaseMethods.md) + * [Address and ETag](Documents/DocumentAddress.md) + * [Collection Methods](Documents/DocumentMethods.md) + * [Database Methods](Documents/DatabaseMethods.md) * [Handling Edges](Edges/README.md) * [Simple Queries](SimpleQueries/README.md) - * [Geo Queries](SimpleQueries/GeoQueries.md) - * [Fulltext Queries](SimpleQueries/FulltextQueries.md) - * [Pagination](SimpleQueries/Pagination.md) - * [Sequential Access](SimpleQueries/Access.md) - * [Modification Queries](SimpleQueries/ModificationQueries.md) + * [Geo Queries](SimpleQueries/GeoQueries.md) + * [Fulltext Queries](SimpleQueries/FulltextQueries.md) + * [Pagination](SimpleQueries/Pagination.md) + * [Sequential Access](SimpleQueries/Access.md) + * [Modification Queries](SimpleQueries/ModificationQueries.md) * [Transactions](Transactions/README.md) - * [Transaction invocation](Transactions/TransactionInvocation.md) - * [Passing parameters](Transactions/Passing.md) - * [Locking and isolation](Transactions/LockingAndIsolation.md) - * [Durability](Transactions/Durability.md) - * [Limitations](Transactions/Limitations.md) + * [Transaction invocation](Transactions/TransactionInvocation.md) + * [Passing parameters](Transactions/Passing.md) + * [Locking and isolation](Transactions/LockingAndIsolation.md) + * [Durability](Transactions/Durability.md) + * [Limitations](Transactions/Limitations.md) * [AQL](Aql/README.md) * [How to invoke AQL](Aql/Invoke.md) @@ -59,68 +59,67 @@ * [Advanced Features](Aql/Advanced.md) * [Extending AQL](AqlExtending/README.md) - * [Conventions](AqlExtending/Conventions.md) - * [Registering Functions](AqlExtending/Functions.md) + * [Conventions](AqlExtending/Conventions.md) + * [Registering Functions](AqlExtending/Functions.md) * [AQL Examples](AqlExamples/README.md) - * [Examples](AqlExamples/Examples.md) - * [Collection based queries](AqlExamples/CollectionQueries.md) - * [Projections and filters](AqlExamples/ProjectionsAndFilters.md) - * [Joins](AqlExamples/Join.md) - * [Grouping](AqlExamples/Grouping.md) + * [Examples](AqlExamples/Examples.md) + * [Collection based queries](AqlExamples/CollectionQueries.md) + * [Projections and filters](AqlExamples/ProjectionsAndFilters.md) + * [Joins](AqlExamples/Join.md) + * [Grouping](AqlExamples/Grouping.md) * [General Graphs](General-Graphs/README.md) * [Graph Management](General-Graphs/Management.md) * [Graph Functions](General-Graphs/Functions.md) - * [Fluent Query Interface](General-Graphs/FluentAQLInterface.md) + * [Fluent Query Interface](General-Graphs/FluentAQLInterface.md) * [(Deprecated) Blueprint Graphs](Blueprint-Graphs/README.md) - * [Graph Constructor](Blueprint-Graphs/GraphConstructor.md) - * [Vertex Methods](Blueprint-Graphs/VertexMethods.md) - * [Edge Methods](Blueprint-Graphs/EdgeMethods.md) + * [Graph Constructor](Blueprint-Graphs/GraphConstructor.md) + * [Vertex Methods](Blueprint-Graphs/VertexMethods.md) + * [Edge Methods](Blueprint-Graphs/EdgeMethods.md) * [Traversals](Traversals/README.md) - * [Starting from Scratch](Traversals/StartingFromScratch.md) - * [Using Traversal Objects](Traversals/UsingTraversalObjects.md) - * [Example Data](Traversals/ExampleData.md) - + * [Starting from Scratch](Traversals/StartingFromScratch.md) + * [Using Traversal Objects](Traversals/UsingTraversalObjects.md) + * [Example Data](Traversals/ExampleData.md) + * [Foxx](Foxx/README.md) - * [Handling Request](Foxx/HandlingRequest.md) + * [Handling Request](Foxx/HandlingRequest.md) * [Manifest](Foxx/FoxxManifest.md) - * [FoxxController](Foxx/FoxxController.md) - * [FoxxModel](Foxx/FoxxModel.md) - * [FoxxRepository](Foxx/FoxxRepository.md) - * [Developing Applications](Foxx/DevelopingAnApplication.md) - * [Deploying Applications](Foxx/DeployingAnApplication.md) - * [Optional Functionlity](Foxx/FoxxOptional.md) - + * [FoxxController](Foxx/FoxxController.md) + * [FoxxModel](Foxx/FoxxModel.md) + * [FoxxRepository](Foxx/FoxxRepository.md) + * [Developing Applications](Foxx/DevelopingAnApplication.md) + * [Optional Functionality](Foxx/FoxxOptional.md) + * [Foxx Manager](FoxxManager/README.md) - * [First Steps](FoxxManager/FirstSteps.md) - * [Behind the scenes](FoxxManager/BehindTheScenes.md) - * [Multiple Databases](FoxxManager/MultipleDatabases.md) - * [Foxx Applications](FoxxManager/ApplicationsAndReplications.md) - * [Manager Commands](FoxxManager/ManagerCommands.md) - * [Frequently Used Options](FoxxManager/FrequentlyUsedOptions.md) - + * [First Steps](FoxxManager/FirstSteps.md) + * [Behind the scenes](FoxxManager/BehindTheScenes.md) + * [Multiple Databases](FoxxManager/MultipleDatabases.md) + * [Foxx Applications](FoxxManager/ApplicationsAndReplications.md) + * [Manager Commands](FoxxManager/ManagerCommands.md) + * [Frequently Used Options](FoxxManager/FrequentlyUsedOptions.md) + * [ArangoDB's Actions](ArangoActions/README.md) - + * [Replication](Replication/README.md) * [Components](Replication/Components.md) * [Example Setup](Replication/ExampleSetup.md) * [Replication Limitations](Replication/Limitations.md) * [Replication Overhead](Replication/Overhead.md) * [Replication Events](Replication/Events.md) - + * [Sharding](Sharding/README.md) - * [How to try it out](Sharding/HowTo.md) - * [Implementation](Sharding/StatusOfImplementation.md) - * [Authentication](Sharding/Authentication.md) - * [Firewall setup](Sharding/FirewallSetup.md) - + * [How to try it out](Sharding/HowTo.md) + * [Implementation](Sharding/StatusOfImplementation.md) + * [Authentication](Sharding/Authentication.md) + * [Firewall setup](Sharding/FirewallSetup.md) + * [Configure ArangoDB](ConfigureArango/README.md) * [General options](ConfigureArango/GeneralOptions.md) * [Arangod options](ConfigureArango/Arangod.md) - * [Endpoints options](ConfigureArango/Endpoint.md) + * [Endpoints options](ConfigureArango/Endpoint.md) * [Development options](ConfigureArango/Development.md) * [Cluster options](ConfigureArango/Cluster.md) * [Logging options](ConfigureArango/Logging.md) @@ -128,19 +127,19 @@ * [Random numbers](ConfigureArango/RandomNumbers.md) * [Authentication](ConfigureArango/Authentication.md) * [Emergency Console](ConfigureArango/EmergencyConsole.md) - + * [Arangoimp](Arangoimp/README.md) - + * [Arangodump](Arangodump/README.md) + +* [Arangorestore](Arangorestore/README.md) -* [Arangorestore](Arangorestore/README.md) - * [HTTP API](HttpApi/README.md) * [Databases](HttpDatabase/README.md) * [To-Endpoint](HttpDatabase/DatabaseEndpoint.md) * [Management](HttpDatabase/DatabaseManagement.md) * [Managing (http)](HttpDatabase/ManagingDatabasesUsingHttp.md) - * [Note on Databases](HttpDatabase/NotesOnDatabases.md) + * [Note on Databases](HttpDatabase/NotesOnDatabases.md) * [Documents](HttpDocument/README.md) * [Address and ETag](HttpDocument/AddressAndEtag.md) * [Working with](HttpDocument/WorkingWithDocuments.md) @@ -162,10 +161,10 @@ * [Address of an Index](HttpIndexes/Address.md) * [Working with Indexes](HttpIndexes/WorkingWith.md) * [Cap Constraints](HttpIndexes/Cap.md) - * [Hash](HttpIndexes/Hash.md) - * [Skiplist](HttpIndexes/Skiplist.md) - * [Geo](HttpIndexes/Geo.md) - * [Fulltext](HttpIndexes/Fulltext.md) + * [Hash](HttpIndexes/Hash.md) + * [Skiplist](HttpIndexes/Skiplist.md) + * [Geo](HttpIndexes/Geo.md) + * [Fulltext](HttpIndexes/Fulltext.md) * [Transactions](HttpTransaction/README.md) * [General Graph](HttpGharial/README.md) * [Management](HttpGharial/Management.md) @@ -193,7 +192,7 @@ * [Sharding](HttpShardingInterface/README.md) * [Miscellaneous functions](HttpMiscellaneousFunctions/README.md) * [General Handling](GeneralHttp/README.md) - + * [Javascript Modules](ModuleJavaScript/README.md) * [Common JSModules](ModuleJavaScript/JSModules.md) * [Path](ModuleJavaScript/ModulesPath.md) @@ -207,9 +206,9 @@ * ["planner"](ModulePlanner/README.md) * [Task Management](ModuleTasks/README.md) * [Using jsUnity](UsingJsUnity/README.md) - + * [Administrating ArangoDB](AdministratingArango/README.md) - + * [Handling Indexes](IndexHandling/README.md) * [Cap Constraint](IndexHandling/Cap.md) * [Geo Indexes](IndexHandling/Geo.md) @@ -217,13 +216,13 @@ * [Hash Indexes](IndexHandling/Hash.md) * [Skip-Lists](IndexHandling/Skiplist.md) * [BitArray Indexes](IndexHandling/BitArray.md) - + * [Datafile Debugger](DatafileDebugger/README.md) - + * [Naming Conventions](NamingConventions/README.md) - * [Database Names](NamingConventions/DatabaseNames.md) - * [Collection Names](NamingConventions/CollectionNames.md) - * [Document Keys](NamingConventions/DocumentKeys.md) - * [Attribute Names](NamingConventions/AttributeNames.md) - -* [Error codes and meanings](ErrorCodes/README.md) + * [Database Names](NamingConventions/DatabaseNames.md) + * [Collection Names](NamingConventions/CollectionNames.md) + * [Document Keys](NamingConventions/DocumentKeys.md) + * [Attribute Names](NamingConventions/AttributeNames.md) + +* [Error codes and meanings](ErrorCodes/README.md) \ No newline at end of file