From 629787d44826a3fb83baefeec65945e70e914be4 Mon Sep 17 00:00:00 2001 From: Alan Greene Date: Fri, 13 May 2022 21:39:08 +0100 Subject: [PATCH] Sync Dashboard docs to the website Add most recent release `v0.26.x` and `main` as the only options for now as we've updated the structure and links to ensure they work correctly on both GitHub and the website. --- .gitignore | 2 + content/en/docs/Dashboard/_index.md | 105 ---------------------------- sync/config/dashboard.yaml | 40 +++++++++++ 3 files changed, 42 insertions(+), 105 deletions(-) delete mode 100644 content/en/docs/Dashboard/_index.md create mode 100644 sync/config/dashboard.yaml diff --git a/.gitignore b/.gitignore index ddd5841..69ddd51 100644 --- a/.gitignore +++ b/.gitignore @@ -24,6 +24,8 @@ content/en/docs/CLI content/en/vault/ content/en/docs/Chains content/en/docs/Operator +content/en/docs/Dashboard +content/en/docs/Results sync/.cache # Local Netlify folder diff --git a/content/en/docs/Dashboard/_index.md b/content/en/docs/Dashboard/_index.md deleted file mode 100644 index bdba49c..0000000 --- a/content/en/docs/Dashboard/_index.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: "Dashboard" -linkTitle: "Dashboard" -weight: 6 -description: > - General-Purpose, Web-Based UI ---- - -{{% pageinfo %}} -This document is a work in progress. -{{% /pageinfo %}} - -## Overview - -Tekton provides a component, Tekton Dashboard, as a general-purpose, -web-based UI for Tekton Pipelines, which allows developers to: - -* View and manage **taskRuns** and **pipelineRuns** -* View and manage resources associated with **taskRuns** and **pipelineRuns** -in their creation, execution, and completion - -## Installation - -{{% tabs %}} - -{{% tab "Kubernetes" %}} -To install the latest release of Tekton Dashboard, run the command below: - -```bash -kubectl apply --filename https://github.com/tektoncd/dashboard/releases/latest/download/tekton-dashboard-release.yaml -``` -{{% /tab %}} - -{{% tab "OpenShift" %}} -To install the latest release of Tekton Dashboard, run the command below: - -```bash -kubectl apply --filename https://github.com/tektoncd/dashboard/releases/latest/download/openshift-tekton-dashboard-release.yaml -``` -{{% /tab %}} - -{{% /tabs %}} - -{{% alert title="Important" color="warning" %}} -The latest release **may not be compatible** with your Tekton Pipelines -installation, should you have an earlier release of Tekton Pipelines -installed. For more compatibility information, see the -[Tekton Dashboard's "Which version should I use?"](https://github.com/tektoncd/dashboard#which-version-should-i-use) -section. - -If you would like to install an earlier release of Tekton Dashboard -for compatibility reasons, see the note below. -{{% /alert %}} - -{{% alert title="Note" color="success" %}} -To install a different release of Tekton Dashboard, find the `.yaml` file -you would like to use on the [Tekton Dashboard Releases](https://github.com/tektoncd/dashboard/releases) -page, and run the command below: - -```bash -# Replace YOUR-RELEASE with the URL of the release you would like to use. -kubectl apply --filename YOUR-RELEASE -``` -{{% /alert %}} - -It may take a few moments before the installation completes. You can check -the progress with the following command: - -```sh -kubectl get pods --namespace tekton-pipelines -``` - -Confirm that every component listed has the status `Running`. - -## Usage - -Tekton Dashboard is accessible through its `cluster IP` type service with -a [reverse proxy](https://kubernetes.io/docs/tasks/access-kubernetes-api/http-proxy-access-api/). -Run the following command: - -```bash -kubectl proxy --port=8080 -``` - -And you can open the dashboard in your browser under the address - -``` -localhost:8080/api/v1/namespaces/tekton-pipelines/services/tekton-dashboard:http/proxy/ -``` - -It is also possible to set up port forwarding with Tekton Dashboard: - -```bash -kubectl --namespace tekton-pipelines port-forward svc/tekton-dashboard 9097:9097 -``` - -Once set up, the dashboard is available in the browser under the address -`localhost:9097`. - -## What's next - -Tekton Dashboard provides many features such as Webhook extension (for setting -up a GitHub repository with a Tekton pipeline in the UI), TLS support, and -Ingress support. For more information, see the -[Tekton Dashboard GitHub repository](https://github.com/tektoncd/dashboard). diff --git a/sync/config/dashboard.yaml b/sync/config/dashboard.yaml new file mode 100644 index 0000000..91fbefa --- /dev/null +++ b/sync/config/dashboard.yaml @@ -0,0 +1,40 @@ +# Each YAML file under sync/ configures how sync/sync.py synchronizes +# contents of various versions from its source of truth (usually a GitHub +# repository of a Tekton component, such as tektoncd/pipelines) to +# content/ (for the lastest version) and vault/ (for earlier versions). + +# The name of the component. +# sync.py will use this value to build directories in content/ and vault/. +component: Dashboard +# The GitHub repository where documentation resides. +repository: https://github.com/tektoncd/dashboard +# The link to the GitHub tag page. +archive: https://github.com/tektoncd/dashboard/tags +# The tags (versions) of contents to sync. +# Note that sync.py and related script reads tags in the order specified in +# the following list; the first entry in tags will automatically become the +# latest version of contents. +# To add a new version, append to the list as below +# - name: vX.Y.Z +# displayName: vX.Y.Z +# folders: +# docs: +# target: '' # optional, default value '' +# index: README.md # optional, if _index.md exists +# include: ['*.md'] # optional, default value ['*'] +# exclude: ['not_in.md'] # optional, default value [] +# header: # optional, no header added if not set +# See https://www.docsy.dev/docs/adding-content/navigation/#section-menu +tags: +- name: release-v0.26.x + displayName: v0.26.x + folders: + docs: + index: README.md + include: ['*.jpg', '*.md', '*.svg'] +- name: main + displayName: main + folders: + docs: + index: README.md + include: ['*.jpg', '*.md', '*.svg'] -- GitLab