2020-12-08 18:26:09 +00:00
|
|
|
# Contributing to Consul
|
|
|
|
|
|
|
|
See [our contributing guide](../.github/CONTRIBUTING.md) to get started.
|
|
|
|
|
|
|
|
This directory contains documentation intended for anyone interested in
|
|
|
|
understanding, and contributing changes to, the Consul codebase.
|
|
|
|
|
2021-04-26 18:58:44 +00:00
|
|
|
## Overview
|
|
|
|
|
|
|
|
This documentation is organized into the following categories. Each category is
|
|
|
|
either a significant architectural layer, or major functional area of Consul.
|
|
|
|
|
|
|
|
![Overview](./overview.svg)
|
|
|
|
|
|
|
|
<sup>[source](./overview.mmd)</sup>
|
|
|
|
|
|
|
|
## Contents
|
2020-12-08 18:26:09 +00:00
|
|
|
|
|
|
|
1. [Overview](./INTERNALS.md)
|
2021-04-26 18:58:44 +00:00
|
|
|
1. [Agent Configuration](./config)
|
|
|
|
1. [RPC](./rpc)
|
|
|
|
1. [Cluster Persistence](./persistence)
|
|
|
|
1. [Client Agent](./client-agent)
|
|
|
|
1. [Service Discovery](./service-discovery)
|
|
|
|
1. [Service Mesh (Connect)](./service-mesh)
|
|
|
|
1. [Cluster Membership](./cluster-membership)
|
|
|
|
1. [Key/Value Store](./kv)
|
|
|
|
1. [ACL](./acl)
|
|
|
|
1. [Multi-Cluster Federation](./cluster-federation)
|