From b396ccbbbf2e87f460576eb32178c8c55758169f Mon Sep 17 00:00:00 2001 From: Daniel Nephin Date: Tue, 8 Dec 2020 13:26:09 -0500 Subject: [PATCH] Move streaming docs to contributing/streaming --- contributing/README.md | 33 +++++++------------ {docs => contributing}/streaming/README.md | 0 .../streaming/event-filtering.mmd | 0 .../streaming/event-filtering.svg | 0 .../streaming/event-publisher-layout.mmd | 0 .../streaming/event-publisher-layout.svg | 0 .../streaming/framing-events.mmd | 0 .../streaming/framing-events.svg | 0 {docs => contributing}/streaming/overview.mmd | 0 {docs => contributing}/streaming/overview.svg | 0 10 files changed, 12 insertions(+), 21 deletions(-) rename {docs => contributing}/streaming/README.md (100%) rename {docs => contributing}/streaming/event-filtering.mmd (100%) rename {docs => contributing}/streaming/event-filtering.svg (100%) rename {docs => contributing}/streaming/event-publisher-layout.mmd (100%) rename {docs => contributing}/streaming/event-publisher-layout.svg (100%) rename {docs => contributing}/streaming/framing-events.mmd (100%) rename {docs => contributing}/streaming/framing-events.svg (100%) rename {docs => contributing}/streaming/overview.mmd (100%) rename {docs => contributing}/streaming/overview.svg (100%) diff --git a/contributing/README.md b/contributing/README.md index 440b5826b..b394d9755 100644 --- a/contributing/README.md +++ b/contributing/README.md @@ -1,21 +1,12 @@ -# Contributing to Consul - -See [our contributing guide](../.github/CONTRIBUTING.md) to get started. - -This directory contains other helpful resources like checklists for making -certain common types of changes. - -## Checklists - -See the `checklist-*` files in this dir to see of there is a checklist that -applies to a change you wish to make. The most common one is a change to -Consul's configuration file which has a lot more steps and subtlety than might -first appear so please use the checklist! - -We recommend copying the raw Markdown lists into a local file or gist while you -work and checking tasks as you complete them (by filling in `[ ]` with `[x]`). -You can then paste the list in the PR description when you post it indicating -the steps you've already done. If you want to post an initial draft PR before -the list is complete, please still include the list as is so reviewers can see -progress. You can then check the list off on the PR description directly in -GitHub's UI after pushing the relevant fixes up. +# 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. + +## Contents + +1. [Overview](./INTERNALS.md) +2. [Configuration](./checklist-adding-config-fields.md) +3. [Streaming](./streaming) diff --git a/docs/streaming/README.md b/contributing/streaming/README.md similarity index 100% rename from docs/streaming/README.md rename to contributing/streaming/README.md diff --git a/docs/streaming/event-filtering.mmd b/contributing/streaming/event-filtering.mmd similarity index 100% rename from docs/streaming/event-filtering.mmd rename to contributing/streaming/event-filtering.mmd diff --git a/docs/streaming/event-filtering.svg b/contributing/streaming/event-filtering.svg similarity index 100% rename from docs/streaming/event-filtering.svg rename to contributing/streaming/event-filtering.svg diff --git a/docs/streaming/event-publisher-layout.mmd b/contributing/streaming/event-publisher-layout.mmd similarity index 100% rename from docs/streaming/event-publisher-layout.mmd rename to contributing/streaming/event-publisher-layout.mmd diff --git a/docs/streaming/event-publisher-layout.svg b/contributing/streaming/event-publisher-layout.svg similarity index 100% rename from docs/streaming/event-publisher-layout.svg rename to contributing/streaming/event-publisher-layout.svg diff --git a/docs/streaming/framing-events.mmd b/contributing/streaming/framing-events.mmd similarity index 100% rename from docs/streaming/framing-events.mmd rename to contributing/streaming/framing-events.mmd diff --git a/docs/streaming/framing-events.svg b/contributing/streaming/framing-events.svg similarity index 100% rename from docs/streaming/framing-events.svg rename to contributing/streaming/framing-events.svg diff --git a/docs/streaming/overview.mmd b/contributing/streaming/overview.mmd similarity index 100% rename from docs/streaming/overview.mmd rename to contributing/streaming/overview.mmd diff --git a/docs/streaming/overview.svg b/contributing/streaming/overview.svg similarity index 100% rename from docs/streaming/overview.svg rename to contributing/streaming/overview.svg