From b1169686dc70a79b653d2bb31868640cb4bf167a Mon Sep 17 00:00:00 2001 From: Krishna Dhakal <7krishna7dhakal7@gmail.com> Date: Tue, 12 Sep 2023 20:07:39 +0545 Subject: [PATCH] Docs: Breaking changes guide in a directory (#72786) Co-authored-by: Marcus Andersson --- .../workflows/detect-breaking-changes-report.yml | 2 +- contribute/README.md | 1 + .../breaking-changes-comment-screenshot.png | Bin .../breaking-changes-console-screenshot-1.png | Bin .../breaking-changes-console-screenshot-2.png | Bin .../breaking-changes-console-screenshot-3.png | Bin .../breaking-changes-guide.md | 0 .../breaking-changes-workflow.png | Bin 8 files changed, 2 insertions(+), 1 deletion(-) rename contribute/{ => breaking-changes-guide}/breaking-changes-comment-screenshot.png (100%) rename contribute/{ => breaking-changes-guide}/breaking-changes-console-screenshot-1.png (100%) rename contribute/{ => breaking-changes-guide}/breaking-changes-console-screenshot-2.png (100%) rename contribute/{ => breaking-changes-guide}/breaking-changes-console-screenshot-3.png (100%) rename contribute/{ => breaking-changes-guide}/breaking-changes-guide.md (100%) rename contribute/{ => breaking-changes-guide}/breaking-changes-workflow.png (100%) diff --git a/.github/workflows/detect-breaking-changes-report.yml b/.github/workflows/detect-breaking-changes-report.yml index 4fbb077b8a4..fbf0431a2a8 100644 --- a/.github/workflows/detect-breaking-changes-report.yml +++ b/.github/workflows/detect-breaking-changes-report.yml @@ -110,7 +110,7 @@ jobs: ${{ steps.levitate-run.outputs.message }} [Console output](${{ steps.levitate-run.outputs.job_link }}) - [Read our guideline](https://github.com/grafana/grafana/blob/main/contribute/breaking-changes-guide.md) + [Read our guideline](https://github.com/grafana/grafana/blob/main/contribute/breaking-changes-guide/breaking-changes-guide.md) # Remove comment from the PR (no more breaking changes) - name: Remove comment from PR diff --git a/contribute/README.md b/contribute/README.md index 3c0ac98d9ca..fcb74bf4073 100644 --- a/contribute/README.md +++ b/contribute/README.md @@ -8,6 +8,7 @@ This directory contains guides for contributors to the Grafana project. - [Triage issues](triage-issues.md) - [Merge a pull request](merge-pull-request.md) - [Making changes to the CI pipeline](drone-pipeline.md) +- [Breaking changes in frontend APIs](./breaking-changes-guide/breaking-changes-guide.md) The `style-guides` directory contains style guides for the Grafana software project and documentation. diff --git a/contribute/breaking-changes-comment-screenshot.png b/contribute/breaking-changes-guide/breaking-changes-comment-screenshot.png similarity index 100% rename from contribute/breaking-changes-comment-screenshot.png rename to contribute/breaking-changes-guide/breaking-changes-comment-screenshot.png diff --git a/contribute/breaking-changes-console-screenshot-1.png b/contribute/breaking-changes-guide/breaking-changes-console-screenshot-1.png similarity index 100% rename from contribute/breaking-changes-console-screenshot-1.png rename to contribute/breaking-changes-guide/breaking-changes-console-screenshot-1.png diff --git a/contribute/breaking-changes-console-screenshot-2.png b/contribute/breaking-changes-guide/breaking-changes-console-screenshot-2.png similarity index 100% rename from contribute/breaking-changes-console-screenshot-2.png rename to contribute/breaking-changes-guide/breaking-changes-console-screenshot-2.png diff --git a/contribute/breaking-changes-console-screenshot-3.png b/contribute/breaking-changes-guide/breaking-changes-console-screenshot-3.png similarity index 100% rename from contribute/breaking-changes-console-screenshot-3.png rename to contribute/breaking-changes-guide/breaking-changes-console-screenshot-3.png diff --git a/contribute/breaking-changes-guide.md b/contribute/breaking-changes-guide/breaking-changes-guide.md similarity index 100% rename from contribute/breaking-changes-guide.md rename to contribute/breaking-changes-guide/breaking-changes-guide.md diff --git a/contribute/breaking-changes-workflow.png b/contribute/breaking-changes-guide/breaking-changes-workflow.png similarity index 100% rename from contribute/breaking-changes-workflow.png rename to contribute/breaking-changes-guide/breaking-changes-workflow.png