From 7546ca31f703140dd5ea43db20a208e523f70e5d Mon Sep 17 00:00:00 2001 From: Robert Fratto Date: Tue, 6 Jul 2021 15:26:32 -0400 Subject: [PATCH] move maintainers guide out of docs move each to cmd//DEVELOPERS.md --- README.md | 1 + .../maintainers-guide.md => cmd/agent-operator/DEVELOPERS.md | 2 +- cmd/agent-operator/README.md | 2 +- docs/maintaining.md => cmd/agent/DEVELOPERS.md | 0 docs/README.md | 3 +-- docs/operator/architecture.md | 3 +-- 6 files changed, 5 insertions(+), 6 deletions(-) rename docs/operator/maintainers-guide.md => cmd/agent-operator/DEVELOPERS.md (99%) rename docs/maintaining.md => cmd/agent/DEVELOPERS.md (100%) diff --git a/README.md b/README.md index b42b088ecb35..d6fcc2c09612 100644 --- a/README.md +++ b/README.md @@ -115,3 +115,4 @@ If you have any questions or feedback regarding the Grafana Agent: [Discussions page](https://github.com/grafana/agent/discussions). * [File an issue](https://github.com/grafana/agent/issues/new) for bugs, issues and feature suggestions. + diff --git a/docs/operator/maintainers-guide.md b/cmd/agent-operator/DEVELOPERS.md similarity index 99% rename from docs/operator/maintainers-guide.md rename to cmd/agent-operator/DEVELOPERS.md index 835ff1d1ae48..4cabb53c2c41 100644 --- a/docs/operator/maintainers-guide.md +++ b/cmd/agent-operator/DEVELOPERS.md @@ -1,4 +1,4 @@ -# Maintainer's Guide +# Developer's Guide This document contains maintainer-specific information. diff --git a/cmd/agent-operator/README.md b/cmd/agent-operator/README.md index 391d4e35eb7d..f60fb17c66b3 100644 --- a/cmd/agent-operator/README.md +++ b/cmd/agent-operator/README.md @@ -33,6 +33,6 @@ and get started with the Grafana Agent Operator. ## Developer Reference -The [Maintainer's Guide](../../docs/operator/maintainers-guide.md) includes +The [Maintainer's Guide](./DEVELOPERS.md) includes basic information to help you understand how the code works. This can be very useful if you are planning on working on the operator. diff --git a/docs/maintaining.md b/cmd/agent/DEVELOPERS.md similarity index 100% rename from docs/maintaining.md rename to cmd/agent/DEVELOPERS.md diff --git a/docs/README.md b/docs/README.md index 6b0f887aa7fd..1117ad486d50 100644 --- a/docs/README.md +++ b/docs/README.md @@ -37,5 +37,4 @@ with: 5. [API](./api.md) 6. [Scraping Service Mode](./scraping-service.md) 7. [Operation Guide](./operation-guide.md) -8. [Maintainers Guide](./maintaining.md) -9. [Windows Guide](./windows.md) +8. [Windows Guide](./windows.md) diff --git a/docs/operator/architecture.md b/docs/operator/architecture.md index 645c2e6c4166..44f4f891a10a 100644 --- a/docs/operator/architecture.md +++ b/docs/operator/architecture.md @@ -6,8 +6,7 @@ weight = 300 # Operator architecture This guide gives a high-level overview of how the Grafana Agent Operator -works. Refer to the [maintainer's guide](./maintainers-guide.md) for -detailed lower-level information targeted at maintainers. +works. The Grafana Agent Operator works in two phases: