Merge pull request #10957 from hashicorp/dnephin/dev-docs

Move ./contributing to ./docs

.github/CONTRIBUTING.md

@@ -105,10 +105,10 @@ If a dependency is added or change, run `go mod tidy` to update `go.mod` and `go
 
 ## Developer Documentation
 
-Documentation about the Consul code base is under [./contributing],
+Documentation about the Consul code base is under [./docs],
 and godoc package document can be read at [pkg.go.dev/github.com/hashicorp/consul].
 
-[./contributing]: ../contributing/README.md
+[./docs]: ../docs/README.md
 [pkg.go.dev/github.com/hashicorp/consul]: https://pkg.go.dev/github.com/hashicorp/consul
 
 ### Checklists
@@ -116,5 +116,5 @@ and godoc package document can be read at [pkg.go.dev/github.com/hashicorp/consu
 Some common changes that many PRs require such as adding config fields, are
 documented through checklists.
 
-Please check in `contributing/` for any `checklist-*.md` files that might help
+Please check in [docs/](../docs/) for any `checklist-*.md` files that might help
 with your change.

INTERNALS.md

@@ -1 +1 @@
-Moved to [contributing/README.md](./contributing/README.md).
+Moved to [docs/README.md](./docs/README.md).

contributing/INTERNALS.md

@@ -1 +1 @@
-Moved to [README.md](./README.md).
+Moved to [docs/README.md](../docs/README.md).

contributing/README.md

@@ -1,81 +1 @@
-# 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.
-
-## 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].
-
-[user documentation]: https://www.consul.io/docs
-
-![Overview](./overview.svg)
-
-<sup>[source](./overview.mmd)</sup>
-
-## Contents 
-
-1. [Command-Line Interface (CLI)](./cli)
-1. [HTTP API](./http-api)
-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)
-
-Also see the [FAQ](./faq.md).
-
-## Important Directories
-
-Most top level directories contain Go source code. The directories listed below
-contain other important source related to Consul.
-
-* [ui] contains the source code for the Consul UI.
-* [website] contains the source for [consul.io](https://www.consul.io/). A pull requests
-  can update the source code and Consul's documentation at the same time.
-* [.circleci] and [.github] contain the source for our CI and GitHub repository
-  automation.
-* [.changelog] contains markdown files that are used by [hashicorp/go-changelog] to produce the
-  [CHANGELOG.md].
-* [build-support] contains bash functions and scripts used to automate.
-  development tasks. Generally these scripts are called from the [GNUmakefile].
-* [grafana] contains the source for a [Grafana dashboard] that can be used to
-  monitor Consul.
-
-[ui]: https://github.com/hashicorp/consul/tree/main/ui
-[website]: https://github.com/hashicorp/consul/tree/main/website
-[.circleci]: https://github.com/hashicorp/consul/tree/main/.circleci
-[.github]: https://github.com/hashicorp/consul/tree/main/.github
-[.changelog]: https://github.com/hashicorp/consul/tree/main/.changelog
-[hashicorp/go-changelog]: https://github.com/hashicorp/go-changelog
-[CHANGELOG.md]: https://github.com/hashicorp/consul/blob/main/CHANGELOG.md
-[build-support]: https://github.com/hashicorp/consul/tree/main/build-support
-[GNUmakefile]: https://github.com/hashicorp/consul/tree/main/GNUmakefile
-[Grafana dashboard]: https://grafana.com/grafana/dashboards
-[grafana]: https://github.com/hashicorp/consul/tree/main/grafana
-
-
-## 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.
-
-[mermaid-js live editor]: https://mermaid-js.github.io/mermaid-live-editor/edit/
-[mermaid-js docs]: https://mermaid-js.github.io/mermaid/
-[consul-mermaid-theme.json]: ./consul-mermaid-theme.json
+Moved to [docs](../docs/README.md).

docs/README.md

@@ -0,0 +1,81 @@
+# Consul Developer Documentation
+
+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.
+
+## 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
+be found in the public [user documentation].
+
+[user documentation]: https://www.consul.io/docs
+
+![Overview](./overview.svg)
+
+<sup>[source](./overview.mmd)</sup>
+
+## Contents 
+
+1. [Command-Line Interface (CLI)](./cli)
+1. [HTTP API](./http-api)
+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)
+
+Also see the [FAQ](./faq.md).
+
+## Important Directories
+
+Most top level directories contain Go source code. The directories listed below
+contain other important source related to Consul.
+
+* [ui] contains the source code for the Consul UI.
+* [website] contains the source for [consul.io](https://www.consul.io/). A pull requests
+  can update the source code and Consul's documentation at the same time.
+* [.circleci] and [.github] contain the source for our CI and GitHub repository
+  automation.
+* [.changelog] contains markdown files that are used by [hashicorp/go-changelog] to produce the
+  [CHANGELOG.md].
+* [build-support] contains bash functions and scripts used to automate.
+  development tasks. Generally these scripts are called from the [GNUmakefile].
+* [grafana] contains the source for a [Grafana dashboard] that can be used to
+  monitor Consul.
+
+[ui]: https://github.com/hashicorp/consul/tree/main/ui
+[website]: https://github.com/hashicorp/consul/tree/main/website
+[.circleci]: https://github.com/hashicorp/consul/tree/main/.circleci
+[.github]: https://github.com/hashicorp/consul/tree/main/.github
+[.changelog]: https://github.com/hashicorp/consul/tree/main/.changelog
+[hashicorp/go-changelog]: https://github.com/hashicorp/go-changelog
+[CHANGELOG.md]: https://github.com/hashicorp/consul/blob/main/CHANGELOG.md
+[build-support]: https://github.com/hashicorp/consul/tree/main/build-support
+[GNUmakefile]: https://github.com/hashicorp/consul/tree/main/GNUmakefile
+[Grafana dashboard]: https://grafana.com/grafana/dashboards
+[grafana]: https://github.com/hashicorp/consul/tree/main/grafana
+
+
+## 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.
+
+[mermaid-js live editor]: https://mermaid-js.github.io/mermaid-live-editor/edit/
+[mermaid-js docs]: https://mermaid-js.github.io/mermaid/
+[consul-mermaid-theme.json]: ./consul-mermaid-theme.json