open-consul/contributing
Daniel Nephin d313219e85 contributing: start an outline for more docs
Add diagrams for rpc routing and acl entity relationship
contributing: create directory structure for new docs
WIP diagram for catalog entities
Add overview diagram

Co-Authored-By: Kelly Devlin <kdevlin@hashicorp.com>
2021-07-05 18:25:00 -04:00
..
acl contributing: start an outline for more docs 2021-07-05 18:25:00 -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
persistence contributing: start an outline for more docs 2021-07-05 18:25:00 -04:00
rpc contributing: start an outline for more docs 2021-07-05 18:25:00 -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 Update references to the main branch 2021-06-29 17:17:38 -04:00
README.md contributing: start an outline for more docs 2021-07-05 18:25:00 -04:00
consul-mermaid-theme.json contributing: start an outline for more docs 2021-07-05 18:25:00 -04:00
overview.mmd contributing: start an outline for more docs 2021-07-05 18:25:00 -04:00
overview.svg contributing: start an outline for more docs 2021-07-05 18:25:00 -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.

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