From 425d0f86b7e9340018318a4f30a4d59301027c87 Mon Sep 17 00:00:00 2001 From: Vincent Demeester Date: Wed, 3 Feb 2021 11:17:37 +0100 Subject: [PATCH] Renaming branches: handling website repository Changing links to any reference to tektoncd/website. Signed-off-by: Vincent Demeester --- content/en/doc-con-main.md | 12 ++++++------ themes/docsy/layouts/partials/page-meta-links.html | 10 +++++----- tutorials/katacoda/getting-started/concepts.md | 2 +- tutorials/katacoda/getting-started/intro.md | 2 +- .../src/tekton-katacoda/resources/git.yaml | 3 +-- tutorials/katacoda/runs/intro.md | 2 +- tutorials/katacoda/tasks/intro.md | 2 +- 7 files changed, 16 insertions(+), 17 deletions(-) diff --git a/content/en/doc-con-main.md b/content/en/doc-con-main.md index 9798b03..d4d2778 100644 --- a/content/en/doc-con-main.md +++ b/content/en/doc-con-main.md @@ -46,10 +46,10 @@ Here's how we handle different types of documentation work: If you're making a quick fix, such as a typo, or adding a few words of clarification, simply submit a pull request against the relevant [Tekton repository](https://github.com/tektoncd). If you're submitting a larger change, also create an issue that describes the new or updated -content and link the pull request to it. +content and link the pull request to it. **Note:** If you're creating a new page, make sure to include its proposed location within the -Tekton documentation set. +Tekton documentation set. Assign the pull request and if applicable, the accompanying issue to @sergetron, Tekton's technical writer. The pull request then goes through technical and editorial review, and is @@ -66,7 +66,7 @@ of this guide to learn how to produce clear, concise, and informative documentat If you found a problem with Tekton documentation but can't fix it yourself, you can request a documentation improvement by creating an issue against the relevant [Tekton repository](https://github.com/tektoncd) -and assigning it to @sergetron, Tekton's technical writer. +and assigning it to @sergetron, Tekton's technical writer. We evaluate the need to determine the scope of the requested content and an estimated delivery time based on our current workload. We then place the issue in the documentation queue. @@ -78,11 +78,11 @@ review, and is published on the Tekton documentation website. Submit a documentation change by opening a pull request against the relevant [Tekton repository](https://github.com/tektoncd). Documentation for each project is stored -in the `docs` directory within the repository. +in the `docs` directory within the repository. Tekton documentation is mirrored on the [Tekton website](https://tekton.dev) with the GitHub repositories acting as the source of truth. If you are adding a new page to a project's documentation, -you must also [add it to the website's configuration](https://github.com/tektoncd/website/tree/master/sync/config) +you must also [add it to the website's configuration](https://github.com/tektoncd/website/tree/main/sync/config) so that it's picked up by the synchronization script and appears in the navigation tree in the "Documentation" section. Depending on the content you're adding, you may also want to add links to your new page to existing Tekton documentation. @@ -90,7 +90,7 @@ to your new page to existing Tekton documentation. ## I need help! If you're not sure how to address a certain documentation issue, join the -[#docs channel](https://app.slack.com/client/TJ45YV83X/CQYFEE00K) on the Tekton Slack and ask! +[#docs channel](https://app.slack.com/client/TJ45YV83X/CQYFEE00K) on the Tekton Slack and ask! Also, before and while you contribute, read the following topics: diff --git a/themes/docsy/layouts/partials/page-meta-links.html b/themes/docsy/layouts/partials/page-meta-links.html index 21d2ece..aa2cd75 100644 --- a/themes/docsy/layouts/partials/page-meta-links.html +++ b/themes/docsy/layouts/partials/page-meta-links.html @@ -4,19 +4,19 @@ {{ $gh_project_repo := ($.Param "github_project_repo") }} {{ if $gh_repo }}
-{{ $editURL := printf "%s/edit/master/content/%s" $gh_repo .Path }} +{{ $editURL := printf "%s/edit/main/content/%s" $gh_repo .Path }} {{ if $gh_project_repo }} {{ $filename := .File.LogicalName }} {{ if and $gh_project_repo (eq $filename "_index.md") }} {{ $filename = "README.md" }} {{ end }} -{{ $editURL = printf "%s/edit/master/docs/%s" $gh_project_repo $filename }} +{{ $editURL = printf "%s/edit/main/docs/%s" $gh_project_repo $filename }} {{ else if and ($gh_subdir) (.Site.Language.Lang) }} -{{ $editURL = printf "%s/edit/master/%s/content/%s/%s" $gh_repo $gh_subdir ($.Site.Language.Lang) $.Path }} +{{ $editURL = printf "%s/edit/main/%s/content/%s/%s" $gh_repo $gh_subdir ($.Site.Language.Lang) $.Path }} {{ else if .Site.Language.Lang }} -{{ $editURL = printf "%s/edit/master/content/%s/%s" $gh_repo ($.Site.Language.Lang) .Path }} +{{ $editURL = printf "%s/edit/main/content/%s/%s" $gh_repo ($.Site.Language.Lang) .Path }} {{ else if $gh_subdir }} -{{ $editURL = printf "%s/edit/master/%s/content/%s" $gh_repo $gh_subdir $.Path }} +{{ $editURL = printf "%s/edit/main/%s/content/%s" $gh_repo $gh_subdir $.Path }} {{ end }} {{ $issuesURL := printf "%s/issues/new?title=%s" $gh_repo (htmlEscape ($.Title | default $.LinkTitle ))}} {{ T "post_edit_this" }} diff --git a/tutorials/katacoda/getting-started/concepts.md b/tutorials/katacoda/getting-started/concepts.md index c31f124..75b5034 100644 --- a/tutorials/katacoda/getting-started/concepts.md +++ b/tutorials/katacoda/getting-started/concepts.md @@ -7,4 +7,4 @@ For example, if you plan to build a CI/CD system that builds source code from your GitHub repository into a container image, the Tekton pipeline may look as follows: -![architecture](https://github.com/tektoncd/website/tree/master/tutorials/katacoda/getting-started/images/architecture.png?raw=true) +![architecture](https://github.com/tektoncd/website/tree/main/tutorials/katacoda/getting-started/images/architecture.png?raw=true) diff --git a/tutorials/katacoda/getting-started/intro.md b/tutorials/katacoda/getting-started/intro.md index 7bca8c6..8fcbaf3 100644 --- a/tutorials/katacoda/getting-started/intro.md +++ b/tutorials/katacoda/getting-started/intro.md @@ -1,4 +1,4 @@ -![logo](https://raw.githubusercontent.com/tektoncd/website/master/tutorials/katacoda/logo.png) +![logo](https://raw.githubusercontent.com/tektoncd/website/main/tutorials/katacoda/logo.png) Tekton is a powerful and flexible open-source framework for creating CI/CD systems, allowing developers to build, test, and deploy across diff --git a/tutorials/katacoda/getting-started/src/tekton-katacoda/resources/git.yaml b/tutorials/katacoda/getting-started/src/tekton-katacoda/resources/git.yaml index d96734b..60c9e83 100644 --- a/tutorials/katacoda/getting-started/src/tekton-katacoda/resources/git.yaml +++ b/tutorials/katacoda/getting-started/src/tekton-katacoda/resources/git.yaml @@ -8,8 +8,7 @@ spec: params: # The revision/branch of the repository - name: revision - value: master + value: main # The URL of the repository - name: url value: https://github.com/tektoncd/website/ - diff --git a/tutorials/katacoda/runs/intro.md b/tutorials/katacoda/runs/intro.md index 0c23ede..a1ff361 100644 --- a/tutorials/katacoda/runs/intro.md +++ b/tutorials/katacoda/runs/intro.md @@ -1,4 +1,4 @@ -![logo](https://raw.githubusercontent.com/tektoncd/website/master/tutorials/katacoda/logo.png) +![logo](https://raw.githubusercontent.com/tektoncd/website/main/tutorials/katacoda/logo.png) [Tekton](https://tekton.dev) is a cloud native continuous integration and delivery (CI/CD) solution. It allows developers to build, test, and deploy diff --git a/tutorials/katacoda/tasks/intro.md b/tutorials/katacoda/tasks/intro.md index 6299c65..6005fc7 100644 --- a/tutorials/katacoda/tasks/intro.md +++ b/tutorials/katacoda/tasks/intro.md @@ -1,4 +1,4 @@ -![logo](https://raw.githubusercontent.com/tektoncd/website/master/tutorials/katacoda/logo.png) +![logo](https://raw.githubusercontent.com/tektoncd/website/main/tutorials/katacoda/logo.png) [Tekton](https://tekton.dev) is a cloud native continuous integration and delivery (CI/CD) solution. It allows developers to build, test, and deploy -- GitLab