arangodb/Documentation/Books/Users/SUMMARY.md

Summary

#* First Steps

* Getting Familiar

• Getting Started

  move to administration (command line options)?

  #* Install and run the server
  • Installing
    • Linux
    • Mac OS X
    • Windows
    • ARM
    • Compiling
    • Cluster setup
  • Using the Web Interface
  • Your first queries
  • Coming from SQL
  • Coming from MongoDB

• Scalability
  • Joins

• Data model & modeling #* Collections
  • Concepts
  • Databases
    • Working with Databases
    • Notes about Databases
  • Collections
    • Collection Methods
    • Database Methods
  • Documents
    • Basics and Terminology
    • Collection Methods
    • Database Methods
  • Graphs, Vertices & Edges
  • Naming Conventions
    • Database Names
    • Collection Names
    • Document Keys
    • Attribute Names
  • Modeling Relationships

  Best practice? (Date handling, Versioning / Revisions

  Add a fake chapter for AQL to go to the AQL docs?

  #* AQL query language

  * 10-minutes guide

  * Using Joins in AQL

  * Dynamic attribute names

  ...

• Indexing
  • Index Basics
  • Which Index to use when
  • How ArangoDB uses indexes
  • Working with Indexes
    • Hash Indexes
    • Skiplists
    • Fulltext Indexes
    • Geo Indexes
    • Cap Constraint

• Graphs
  • General Graphs
    • Graph Management
    • Graph Functions
    • Fluent Query Interface
  • Traversals
    • Using Traversal Objects
    • Example Data
  • Working with Edges

Will be replaced by new FOTF docs

• Foxx microservices
  • In a nutshell
  • Install
    • Github
    • Store
    • Local
    • Remote
    • Generate
  • Development
    • Dev-Mode
    • Debugging
    • Source Files
    • Controller
    • Scripts
    • Model
    • Repository
    • Queries
    • Sessions
    • Background Tasks
    • Console API
    • Meta information
    • Exports
    • Documentation
  • Production
    • Prod-Mode
    • Debugging
    • New Versions
  • Cluster
    • Install
    • Setup & Teardown
• Transactions
  • Transaction invocation
  • Passing parameters
  • Locking and isolation
  • Durability
  • Limitations

Use cases / Advanced usage / Best practice (?)

• Administration
  • ArangoDB Shell
    • Shell Output
    • Configuration

    relocate file?

    • Details
  • Arangoimp
  • Arangodump
  • Arangorestore
  • Upgrading
    • Upgrading to 2.8
    • Upgrading to 2.6
    • Upgrading to 2.5
    • Upgrading to 2.4
    • Upgrading to 2.3
    • Upgrading to 2.2
  • Server Configuration
    • Arangod options
    • Write-ahead log options
    • Managing Endpoints
    • Cluster options
    • Logging options
    • Communication options
    • Authentication
  • Replication
    • Components
    • Example Setup
    • Syncing Collections
    • Replication Limitations
    • Replication Overhead
  • Sharding
    • How to try it out
    • Implementation
    • Authentication
    • Firewall setup

• Deployment

• Troubleshooting
  • Emergency Console
  • Datafile Debugger
  • Arangob

• Architecture
  • Write-ahead log
  • Server Internals

• Release notes
  • Whats New in 2.8
  • Whats New in 2.7
  • Whats New in 2.6
  • Whats New in 2.5
  • Whats New in 2.4
  • Whats New in 2.3
  • Whats New in 2.2
  • Whats New in 2.1

  Place next to Upgrading instead?

  • Incompatible changes in 2.8
  • Incompatible changes in 2.7
  • Incompatible changes in 2.6
  • Incompatible changes in 2.5
  • Incompatible changes in 2.4
  • Incompatible changes in 2.3

• Appendix
  • JavaScript Modules
    • "console"
    • "fs"
    • "process"
    • "request"
    • "actions"
    • "queries"
    • "planner"
    • Write-ahead log
    • Task Management
  • Deprecated
    • Simple Queries
      • Sequential Access
      • Pagination
      • Modification Queries
      • Geo Queries
      • Fulltext Queries
    • Actions
      • Delivering HTML Pages
      • Json Objects
      • Modifying

  Link to here from arangosh, actions, foxx, transactions

  • Error codes and meanings
  • Glossary