consul/contributing
Daniel Nephin a202a10e09 contrib: move FAQ into a separate file. 2021-07-05 18:25:05 -04:00
..
acl
client-agent
cluster-federation
cluster-membership
config
persistence contributing: start an outline for more docs 2021-07-05 18:25:00 -04:00
rpc
service-discovery
service-mesh
INTERNALS.md contrib: move FAQ into a separate file. 2021-07-05 18:25:05 -04:00
README.md contrib: move FAQ into a separate file. 2021-07-05 18:25:05 -04:00
consul-mermaid-theme.json
faq.md contrib: move FAQ into a separate file. 2021-07-05 18:25:05 -04:00
overview.mmd
overview.svg

README.md

Contributing to Consul

See our contributing guide to get started.

This directory contains documentation intended for anyone interested in understanding, and contributing changes to, the Consul codebase.

Overview

This documentation is organized into the following categories. Each category is either a significant architectural layer, or major functional area of Consul. These documents assume a basic understanding of Consul's feature set, which can found in the public user documentation.

Overview

source

Contents

  1. Overview
  2. Agent Configuration
  3. RPC
  4. Cluster Persistence
  5. Client Agent
  6. Service Discovery
  7. Service Mesh (Connect)
  8. Cluster Membership
  9. Key/Value Store
  10. ACL
  11. Multi-Cluster Federation

Also see the FAQ.