From bb69b699b32bf7d70342d5ebee150701bf4b1ac0 Mon Sep 17 00:00:00 2001 From: Daniel Nephin Date: Fri, 20 Aug 2021 16:13:37 -0400 Subject: [PATCH] docs: add important top level directories to the README --- contributing/INTERNALS.md | 1 - contributing/README.md | 30 ++++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+), 1 deletion(-) diff --git a/contributing/INTERNALS.md b/contributing/INTERNALS.md index 1fe71ad021..24368d08aa 100644 --- a/contributing/INTERNALS.md +++ b/contributing/INTERNALS.md @@ -38,4 +38,3 @@ There are several other top-level packages used internally by Consul as well as | --------- | -------- | | [api](https://github.com/hashicorp/consul/tree/main/api) | This `api` package provides an official Go API client for Consul, which is also used by Consul's [CLI](https://www.consul.io/docs/commands/index.html) commands to communicate with the local Consul agent. | | [api/watch](https://github.com/hashicorp/consul/tree/main/api/watch) | This has implementation details for Consul's [watches](https://www.consul.io/docs/agent/watches.html), used both internally to Consul and by the [watch CLI command](https://www.consul.io/docs/commands/watch.html). | -| [website](https://github.com/hashicorp/consul/tree/main/website) | This has the full source code for [consul.io](https://www.consul.io/). Pull requests can update the source code and Consul's documentation all together. | diff --git a/contributing/README.md b/contributing/README.md index 75b3fd99e6..52884fdf9a 100644 --- a/contributing/README.md +++ b/contributing/README.md @@ -36,6 +36,36 @@ found in the public [user documentation]. 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.