From e4158d654d0c338d9020972c7d53bcadf2872bf7 Mon Sep 17 00:00:00 2001 From: "Grot (@grafanabot)" <43478413+grafanabot@users.noreply.github.com> Date: Thu, 7 Jul 2022 09:23:08 +0100 Subject: [PATCH] Add doc-validator tool to CI (#51698) (#51869) * Add doc-validator tool to CI Signed-off-by: Jack Baldry * Use simpler apostrophe to make title match h1 Signed-off-by: Jack Baldry * Ensure doc-validator CI always passes until all errors are resolved Signed-off-by: Jack Baldry (cherry picked from commit 602ee3753321adb47b1768049e8f35ad25508029) Co-authored-by: Jack Baldry --- .github/workflows/doc-validator.yml | 16 ++++++++++++++++ docs/sources/whatsnew/whats-new-in-v7-5.md | 2 +- docs/sources/whatsnew/whats-new-in-v8-0.md | 2 +- docs/sources/whatsnew/whats-new-in-v8-1.md | 2 +- docs/sources/whatsnew/whats-new-in-v8-2.md | 2 +- docs/sources/whatsnew/whats-new-in-v8-3.md | 2 +- docs/sources/whatsnew/whats-new-in-v8-4.md | 2 +- docs/sources/whatsnew/whats-new-in-v8-5.md | 2 +- docs/sources/whatsnew/whats-new-in-v9-0.md | 2 +- 9 files changed, 24 insertions(+), 8 deletions(-) create mode 100644 .github/workflows/doc-validator.yml diff --git a/.github/workflows/doc-validator.yml b/.github/workflows/doc-validator.yml new file mode 100644 index 00000000000..63a2ef54dcb --- /dev/null +++ b/.github/workflows/doc-validator.yml @@ -0,0 +1,16 @@ +name: "doc-validator" +on: + pull_request: + paths: ["docs/sources/**"] + workflow_dispatch: +jobs: + doc-validator: + runs-on: "ubuntu-latest" + container: + image: "grafana/doc-validator:latest" + steps: + - name: "Checkout code" + uses: "actions/checkout@v3" + - name: "Run doc-validator tool" + # Ensure that the CI always passes until all errors are resolved. + run: "doc-validator ./docs/sources || true" diff --git a/docs/sources/whatsnew/whats-new-in-v7-5.md b/docs/sources/whatsnew/whats-new-in-v7-5.md index 21c1aa783f8..0e07db2ee76 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-5.md +++ b/docs/sources/whatsnew/whats-new-in-v7-5.md @@ -15,7 +15,7 @@ title: What's new in Grafana v7.5 weight: -32 --- -# What’s new in Grafana v7.5 +# What's new in Grafana v7.5 This topic includes the release notes for Grafana v7.5. For all details, read the full [CHANGELOG.md](https://github.com/grafana/grafana/blob/master/CHANGELOG.md). diff --git a/docs/sources/whatsnew/whats-new-in-v8-0.md b/docs/sources/whatsnew/whats-new-in-v8-0.md index aba40d713cc..6b64788689d 100644 --- a/docs/sources/whatsnew/whats-new-in-v8-0.md +++ b/docs/sources/whatsnew/whats-new-in-v8-0.md @@ -15,7 +15,7 @@ title: What's new in Grafana v8.0 weight: -33 --- -# What’s new in Grafana v8.0 +# What's new in Grafana v8.0 This topic includes the release notes for Grafana v8.0. For all details, read the full [CHANGELOG.md](https://github.com/grafana/grafana/blob/master/CHANGELOG.md). diff --git a/docs/sources/whatsnew/whats-new-in-v8-1.md b/docs/sources/whatsnew/whats-new-in-v8-1.md index 3e7327dbd33..3c8ba92d9f7 100644 --- a/docs/sources/whatsnew/whats-new-in-v8-1.md +++ b/docs/sources/whatsnew/whats-new-in-v8-1.md @@ -15,7 +15,7 @@ title: What's new in Grafana v8.1 weight: -33 --- -# What’s new in Grafana v8.1 +# What's new in Grafana v8.1 > **Note:** This topic will be updated frequently between now and the final release. diff --git a/docs/sources/whatsnew/whats-new-in-v8-2.md b/docs/sources/whatsnew/whats-new-in-v8-2.md index 5717519ff30..c5f06327920 100644 --- a/docs/sources/whatsnew/whats-new-in-v8-2.md +++ b/docs/sources/whatsnew/whats-new-in-v8-2.md @@ -15,7 +15,7 @@ title: What's new in Grafana v8.2 weight: -33 --- -# What’s new in Grafana v8.2 +# What's new in Grafana v8.2 Grafana 8.2 continues to build on the foundation of Grafana 8.0 & 8.1. Grafana 8.2 also marks the start of our work to bring Grafana closer to all users with a focus on increasing Grafana’s accessibility, part of its continuing mission to democratize metrics _for everyone_. diff --git a/docs/sources/whatsnew/whats-new-in-v8-3.md b/docs/sources/whatsnew/whats-new-in-v8-3.md index 31e86ab89b5..c609c24c4f0 100644 --- a/docs/sources/whatsnew/whats-new-in-v8-3.md +++ b/docs/sources/whatsnew/whats-new-in-v8-3.md @@ -15,7 +15,7 @@ title: What's new in Grafana v8.3 weight: -33 --- -# What’s new in Grafana v8.3 +# What's new in Grafana v8.3 Grafana 8.3 is an exciting release for Grafana Labs. This release includes the new Candlestick Panel, a new visualization suggestions engine and, for enterprise users, Recorded Queries. diff --git a/docs/sources/whatsnew/whats-new-in-v8-4.md b/docs/sources/whatsnew/whats-new-in-v8-4.md index 45ba5fdbb4c..a1de0eef169 100644 --- a/docs/sources/whatsnew/whats-new-in-v8-4.md +++ b/docs/sources/whatsnew/whats-new-in-v8-4.md @@ -15,7 +15,7 @@ title: What's new in Grafana v8.4 weight: -33 --- -# What’s new in Grafana v8.4 +# What's new in Grafana v8.4 We’re excited to announce Grafana v8.4, with a variety of improvements that focus on Grafana’s usability, performance, and security. Read on to learn about Alerting enhancements like a WeCom contact point, improved Alert panel and custom mute timings, as well as visualization improvements and details to help you share playlists more easily. In Grafana Enterprise, we’ve made caching more powerful to save you time and money while loading dashboards, boosted database encryption to keep secrets safe in your Grafana database, and made usability improvements to Recorded Queries, which allow you to track any data point over time. diff --git a/docs/sources/whatsnew/whats-new-in-v8-5.md b/docs/sources/whatsnew/whats-new-in-v8-5.md index 96b19a7deac..1d7fefd60f9 100644 --- a/docs/sources/whatsnew/whats-new-in-v8-5.md +++ b/docs/sources/whatsnew/whats-new-in-v8-5.md @@ -15,7 +15,7 @@ title: What's new in Grafana v8.5 weight: -33 --- -# What’s new in Grafana v8.5 +# What's new in Grafana v8.5 We’re excited to announce Grafana v8.5, with a variety of improvements that focus on Grafana’s usability, performance, and security. diff --git a/docs/sources/whatsnew/whats-new-in-v9-0.md b/docs/sources/whatsnew/whats-new-in-v9-0.md index 638f1f7a2fd..64e6c533171 100644 --- a/docs/sources/whatsnew/whats-new-in-v9-0.md +++ b/docs/sources/whatsnew/whats-new-in-v9-0.md @@ -15,7 +15,7 @@ title: What's new in Grafana v9.0 weight: -33 --- -# What’s new in Grafana v9.0 +# What's new in Grafana v9.0 As tradition goes, GrafanaCon — our yearly community event for Grafana open source users — is also where we launch the latest software release of Grafana. Keeping up with tradition, we are excited to be announcing Grafana v9.0: a release that elevates Grafana’s ease of use, discovery of data through new and improved visualizations and a default Grafana Alerting experience.