From cd770d747cb1fe521b5e060d5280588d2ab4e8a0 Mon Sep 17 00:00:00 2001 From: pipo02mix Date: Thu, 31 Oct 2024 09:37:28 +0100 Subject: [PATCH 1/3] Fix menu layout --- .../data-exploration/accessing-grafana/_index.md | 8 +------- .../creating-custom-dashboards/_index.md | 10 ++-------- .../data-exploration/exploring-logs/_index.md | 4 +--- src/content/tutorials/registry/zot/_index.md | 4 ++-- 4 files changed, 6 insertions(+), 20 deletions(-) diff --git a/src/content/tutorials/observability/data-exploration/accessing-grafana/_index.md b/src/content/tutorials/observability/data-exploration/accessing-grafana/_index.md index 00a0e8606e..6e23456e40 100644 --- a/src/content/tutorials/observability/data-exploration/accessing-grafana/_index.md +++ b/src/content/tutorials/observability/data-exploration/accessing-grafana/_index.md @@ -3,16 +3,10 @@ linkTitle: Accessing Grafana title: How to access Grafana dashboards description: Guide explaining how to get access to the data collected and stored by the Observability Platform. menu: - main: + principal: identifier: tutorials-observability-data-exploration-accessing-grafana parent: tutorials-observability-data-exploration weight: 40 -aliases: - - /getting-started/observability/visualization/access - - /observability/grafana/access - - /ui-api/observability/grafana/access - - /observability/visualization/access - - /ui-api/observability/visualization/access last_review_date: 2024-07-17 user_questions: - How to access Grafana? diff --git a/src/content/tutorials/observability/data-exploration/creating-custom-dashboards/_index.md b/src/content/tutorials/observability/data-exploration/creating-custom-dashboards/_index.md index ad1411d1b4..6c4d6d82e5 100644 --- a/src/content/tutorials/observability/data-exploration/creating-custom-dashboards/_index.md +++ b/src/content/tutorials/observability/data-exploration/creating-custom-dashboards/_index.md @@ -3,16 +3,10 @@ linkTitle: Creating custom Grafana dashboards title: Creating custom Grafana dashboards description: Guide explaining how to manage custom Grafana dashboards in the Observability Platform. menu: - main: + principal: identifier: tutorials-observability-data-exploration-create-custom-dashboards - parent: tutorials-observability-data-exploration-create-observability-visualization + parent: tutorials-observability-data-exploration weight: 40 -aliases: - - /advanced/observability/visualization/custom-dashboards - - /observability/grafana/custom-dashboards - - /observability/visualization/custom-dashboards - - /ui-api/observability/grafana/custom-dashboards - - /ui-api/observability/visualization/custom-dashboards last_review_date: 2024-07-17 user_questions: - How to customize dashboards? diff --git a/src/content/tutorials/observability/data-exploration/exploring-logs/_index.md b/src/content/tutorials/observability/data-exploration/exploring-logs/_index.md index 5916698d00..b07f0f7ae8 100644 --- a/src/content/tutorials/observability/data-exploration/exploring-logs/_index.md +++ b/src/content/tutorials/observability/data-exploration/exploring-logs/_index.md @@ -3,12 +3,10 @@ linkTitle: Exploring logs with LogQL title: Exploring logs with LogQL description: Guide explaining how to get explore logs of your management and workload clusters stored in the Observability Platform. menu: - main: + principal: identifier: tutorials-observability-data-exploration-exploring-logs parent: tutorials-observability-data-exploration weight: 40 -aliases: - - /getting-started/observability/visualization/exploring-logs last_review_date: 2024-07-17 user_questions: - How to access logs from my installation? diff --git a/src/content/tutorials/registry/zot/_index.md b/src/content/tutorials/registry/zot/_index.md index aa77e49d0c..565824f86b 100644 --- a/src/content/tutorials/registry/zot/_index.md +++ b/src/content/tutorials/registry/zot/_index.md @@ -4,13 +4,13 @@ title: Setting up a caching container registry within a cluster using Zot description: A registry cache within the cluster can provide benefits for availability, performance, and cost. Here we explain how to set up a registry, using the Zot app provided by Giant Swarm. weight: 110 menu: - main: + principal: parent: tutorials-registry identifier: tutorials-registry-in-cluster-cache-using-zot user_questions: - How can I cache container images within the cluster? - How can I have a backup registry for container images? -last_review_date: 2024-07-12 +last_review_date: 2024-10-31 owner: - https://github.com/orgs/giantswarm/teams/team-honeybadger --- From bb865c34d0039e022258a5f9802fd5c7bd5367d2 Mon Sep 17 00:00:00 2001 From: pipo02mix Date: Fri, 13 Dec 2024 12:01:20 +0100 Subject: [PATCH 2/3] Fix review issues workflow --- .github/workflows/generate-review-issues.yaml | 11 ++++++----- Makefile | 9 +++++++++ scripts/validate-front-matter/script.py | 3 ++- 3 files changed, 17 insertions(+), 6 deletions(-) diff --git a/.github/workflows/generate-review-issues.yaml b/.github/workflows/generate-review-issues.yaml index f5aac5b017..b2c5317596 100644 --- a/.github/workflows/generate-review-issues.yaml +++ b/.github/workflows/generate-review-issues.yaml @@ -2,7 +2,7 @@ name: Generate review Issues weekly on: schedule: # At 0:00 on Sundays - - cron: '0 0 * * 0' + - cron: '0 0 * * 0' jobs: @@ -16,12 +16,13 @@ jobs: run: pip3 install click colored PyYAML - name: Validate front matter and last review date - run: | - echo "ISSUES=$(python3 scripts/validate-front-matter/script.py --validation last-reviewed --output json)" >> $GITHUB_ENV - + env: + GITHUB_TOKEN: ${{ secrets.TOKEN }} + run: make validate-last-reviewed + - name: Generate issues of out of date docs uses: giantswarm/open-issue@7774937e31b23a52257a34462a753b0a28a4d1f1 # 0.3.0 - with: + with: token: ${{ secrets.ISSUE_AUTOMATION }} org: giantswarm repo: giantswarm diff --git a/Makefile b/Makefile index a0de47560f..cdc47d14db 100644 --- a/Makefile +++ b/Makefile @@ -114,6 +114,15 @@ validate-front-matter: $(REGISTRY)/$(COMPANY)/docs-scriptrunner:latest \ /workdir/scripts/validate-front-matter/script.py +# Validate front matter in all pages. +validate-last-reviewed: + docker run --rm \ + --volume=${PWD}:/workdir:ro \ + -w /workdir \ + $(REGISTRY)/$(COMPANY)/docs-scriptrunner:latest \ + /workdir/scripts/validate-front-matter/script.py --validation last-reviewed \ + --output json + # Print a report of pages with a last_review_date that's # too long ago. validate-last-reviewed: diff --git a/scripts/validate-front-matter/script.py b/scripts/validate-front-matter/script.py index 7545e7e95e..d67352474a 100644 --- a/scripts/validate-front-matter/script.py +++ b/scripts/validate-front-matter/script.py @@ -18,6 +18,7 @@ crds_path = 'src/content/reference/platform-api/crd' vintage_crds_path = 'src/content/vintage/use-the-api/management-api/crd' cluster_apps_path = 'src/content/reference/platform-api/cluster-apps' +meta_path = 'src/content/meta' docs_host = 'https://github.com/giantswarm/docs/blob/main/' todays_date = datetime.date.today() @@ -161,7 +162,7 @@ { 'id': NO_LAST_REVIEW_DATE, 'description': 'The page should have a last_review_date', - 'ignore_paths': [crds_path, vintage_crds_path, changes_path, cluster_apps_path], + 'ignore_paths': [crds_path, vintage_path, changes_path, cluster_apps_path, meta_path], 'severity': SEVERITY_WARN, }, { From 2013ee2e521e681bd8b7cb9d259229d9d5b4e555 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 17 Dec 2024 12:56:06 +0100 Subject: [PATCH 3/3] Update gsoci.azurecr.io/giantswarm/crd-docs-generator Docker tag to v0.11.2 (#2434) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Fernando Ripoll --- scripts/update-crd-reference/main.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/update-crd-reference/main.sh b/scripts/update-crd-reference/main.sh index b39843fa88..64ca1a3808 100755 --- a/scripts/update-crd-reference/main.sh +++ b/scripts/update-crd-reference/main.sh @@ -3,7 +3,7 @@ set -e # renovate: datasource=docker depName=gsoci.azurecr.io/giantswarm/crd-docs-generator versioning=loose -CRD_DOCS_GENERATOR_VERSION=0.11.1 +CRD_DOCS_GENERATOR_VERSION=0.11.2 DESTINATION=src/content/reference/platform-api/crd