consul/contributing

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.

^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.