blob: f4bed795676a4e7a936899c82f36281d6fd940dc [file] [log] [blame]
groups:
- name: Getting started
dir: getting-started
docs:
- name: Installation
endpoint: installation
- name: Run bookies locally
endpoint: run-locally
- name: Concepts and architecture
endpoint: concepts
- name: Deployment
dir: deployment
docs:
- name: Manual deployment
endpoint: manual
- name: BookKeeper on DC/OS
endpoint: dcos
- name: BookKeeper on Kubernetes
endpoint: kubernetes
- name: Administration
dir: admin
docs:
- name: BookKeeper administration
endpoint: bookies
- name: AutoRecovery
endpoint: autorecovery
- name: Metric collection
endpoint: metrics
- name: Upgrade
endpoint: upgrade
- name: BookKeeper Admin REST API
endpoint: http
#- name: Geo-replication
# endpoint: geo-replication
#- name: Customized placement policies
# endpoint: placement
#- name: Performance tuning
# endpoint: perf
- name: API
dir: api
docs:
- name: Overview
endpoint: overview
- name: Ledger API
endpoint: ledger-api
- name: Advanced Ledger API
endpoint: ledger-adv-api
- name: DistributedLog
endpoint: distributedlog-api
- name: Java API Docs
endpoint: javadoc
- name: Security
dir: security
docs:
- name: Overview
endpoint: overview
- name: TLS Authentication
endpoint: tls
- name: SASL Authentication
endpoint: sasl
- name: ZooKeeper Authentication
endpoint: zookeeper
- name: Development
dir: development
docs:
- name: BookKeeper protocol
endpoint: protocol
#- name: Codebase
# endpoint: codebase
- name: Reference
dir: reference
docs:
- name: Configuration
endpoint: config
- name: Command-line tools
endpoint: cli
- name: Metrics
endpoint: metrics