From b58db18c01d44f89e2844793d9387bb1aac5fdc1 Mon Sep 17 00:00:00 2001 From: Niki Date: Tue, 6 Jun 2023 15:56:39 +0200 Subject: [PATCH] Docs: Update references in `contribute/` dir (#69564) Docs: Update references in `contribute` dir --- contribute/architecture/README.md | 6 +----- contribute/backend/README.md | 5 ++++- contribute/backend/errors.md | 2 +- contribute/backend/instrumentation.md | 2 +- contribute/developer-guide.md | 1 + 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/contribute/architecture/README.md b/contribute/architecture/README.md index 522fa2311ae..699ac8be797 100644 --- a/contribute/architecture/README.md +++ b/contribute/architecture/README.md @@ -2,11 +2,7 @@ Are you looking to take on contributions with bigger impact? These guides help you get a better understanding of the structure and design of the Grafana codebase. -Learn more about the backend architecture: - -- Part 1: [Services](../backend/services.md) -- Part 2: [Communication](../backend/communication.md) -- Part 3: [Database](../backend/database.md) +Learn more about the backend architecture in [contribute/backend](/contribute/backend/README.md). Learn more about the frontend architecture: diff --git a/contribute/backend/README.md b/contribute/backend/README.md index 3a26265bc83..75fd19a191a 100644 --- a/contribute/backend/README.md +++ b/contribute/backend/README.md @@ -21,4 +21,7 @@ of familiarizing themselves with the content of ## Dependency management -Refer to [UPGRADING_DEPENDENCIES.md](https://github.com/grafana/grafana/blob/main/UPGRADING_DEPENDENCIES.md). +Refer to: + +- [UPGRADING_DEPENDENCIES.md](https://github.com/grafana/grafana/blob/main/UPGRADING_DEPENDENCIES.md) +- [Upgrading dependencies](/contribute/backend/upgrading-dependencies.md) diff --git a/contribute/backend/errors.md b/contribute/backend/errors.md index 15da1921173..fed461c46f5 100644 --- a/contribute/backend/errors.md +++ b/contribute/backend/errors.md @@ -1,6 +1,6 @@ # Errors -Grafana introduced its own error type `github.com/grafana/grafana/pkg/util/errutil.Error` +Grafana introduced its own error type [github.com/grafana/grafana/pkg/util/errutil.Error](../../pkg/util/errutil/errors.go) in June 2022. It's built on top of the Go `error` interface extended to contain all the information necessary by Grafana to handle errors in an informative and safe way. diff --git a/contribute/backend/instrumentation.md b/contribute/backend/instrumentation.md index f2b8d6569fe..e87f628ed77 100644 --- a/contribute/backend/instrumentation.md +++ b/contribute/backend/instrumentation.md @@ -8,7 +8,7 @@ Logs are files that record events, warnings and errors as they occur within a so ### Usage -Use the _pkg/infra/log_ package to create a named structured logger. Example: +Use the [pkg/infra/log](/pkg/infra/log/) package to create a named structured logger. Example: ```go import ( diff --git a/contribute/developer-guide.md b/contribute/developer-guide.md index fb20192b939..6e3eeb94d9d 100644 --- a/contribute/developer-guide.md +++ b/contribute/developer-guide.md @@ -290,3 +290,4 @@ If that happens to you, chances are you've already set a lower limit and your sh - Read our [style guides](/contribute/style-guides). - Learn how to [Create a pull request](/contribute/create-pull-request.md). - Read about the [architecture](architecture). +- Read through the [backend documentation](/contribute/backend/README.md).