open-consul/contributing
Daniel Nephin b1b9ca70b5 contrib: add list of check register flows 2021-08-12 12:08:36 -04:00
..
acl contrib: add first draft of ACL docs 2021-07-05 18:25:06 -04:00
cli
client-agent
cluster-federation
cluster-membership
config contrib: add first draft of agent configuration docs 2021-07-14 16:48:15 -04:00
http-api
persistence
rpc contrib: add first draft of RPC docs 2021-07-07 13:38:10 -04:00
service-discovery contrib: add list of check register flows 2021-08-12 12:08:36 -04:00
service-mesh
INTERNALS.md contrib: add first draft of ACL docs 2021-07-05 18:25:06 -04:00
README.md contrib: add docs about the diagrams 2021-07-07 13:42:13 -04:00
consul-mermaid-theme.json contrib: add first draft of ACL docs 2021-07-05 18:25:06 -04:00
faq.md
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.

Contributing to these docs

This section is meta documentation about contributing to these docs.

Diagrams

The diagrams in these documents are created using the mermaid-js live editor. The mermaid-js docs provide a complete reference for how to create and edit the diagrams. Use the consul-mermaid-theme.json (paste it into the Config tab in the editor) to maintain a consistent Consul style for the diagrams.