status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
consul/contributing
History
Daniel Nephin c96991b35d Fix typo in overview diagram 2021-07-07 13:38:10 -04:00
..
acl contrib: add first draft of ACL docs 2021-07-05 18:25:06 -04:00
cli contrib: Add CLI docs 2021-07-05 18:25:05 -04:00
client-agent contributing: start an outline for more docs 2021-07-05 18:25:00 -04:00
cluster-federation contributing: start an outline for more docs 2021-07-05 18:25:00 -04:00
cluster-membership contributing: start an outline for more docs 2021-07-05 18:25:00 -04:00
config contributing: start an outline for more docs 2021-07-05 18:25:00 -04:00
http-api contrib: Add CLI docs 2021-07-05 18:25:05 -04:00
persistence contrib: Add cluster persistence docs 2021-07-05 18:25:06 -04:00
rpc contrib: add first draft of RPC docs 2021-07-07 13:38:10 -04:00
service-discovery contributing: start an outline for more docs 2021-07-05 18:25:00 -04:00
service-mesh contributing: start an outline for more docs 2021-07-05 18:25:00 -04:00
INTERNALS.md contrib: add first draft of ACL docs 2021-07-05 18:25:06 -04:00
README.md contrib: Add CLI docs 2021-07-05 18:25:05 -04:00
consul-mermaid-theme.json contrib: add first draft of ACL docs 2021-07-05 18:25:06 -04:00
faq.md contrib: move FAQ into a separate file. 2021-07-05 18:25:05 -04:00
overview.mmd Fix typo in overview diagram 2021-07-07 13:38:10 -04:00
overview.svg Fix typo in overview diagram 2021-07-07 13:38:10 -04:00

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. Command-Line Interface (CLI)
  3. HTTP API
  4. Agent Configuration
  5. RPC
  6. Cluster Persistence
  7. Client Agent
  8. Service Discovery
  9. Service Mesh (Connect)
  10. Cluster Membership
  11. Key/Value Store
  12. ACL
  13. Multi-Cluster Federation

Also see the FAQ.