-
Notifications
You must be signed in to change notification settings - Fork 221
Add permanent url for the latest Linkerd docs #2116
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
35fa0cf
e6326da
81ab440
c651c28
a787d37
2cbb808
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -153,8 +153,8 @@ list page. If a cover image is not present, or you would like to use a different | |
| image than the cover image, you can name it `feature` and place it in the blog | ||
| post folder. | ||
|
|
||
| **Note:** When a blog post is featured on the blog listing it will be | ||
| cropped into a 4x1 ratio. | ||
| **Note:** When a blog post is featured on the blog listing it will be cropped | ||
| into a 4x1 ratio. | ||
|
|
||
| #### Thumbnail images | ||
|
|
||
|
|
@@ -289,31 +289,29 @@ bash {class=disable-copy} | |
| ### Creating a new major version | ||
|
|
||
| To create a new major version for the Linkerd docs, follow the steps below. As | ||
| an example we suppose the latest major is `2.18` and we'd like to create docs | ||
| for the upcoming `2.19` version, that will appear at `https://linkerd.io/2.19`. | ||
| an example we suppose the latest major is `2.19` and we'd like to create docs | ||
| for the upcoming `2.20` version. | ||
|
|
||
| - Clone the `https://github.com/linkerd/website` repo | ||
| - Create a new branch `yourusername/2.19` | ||
| - Create a new branch `yourusername/2.20` | ||
| - Update the latest version in `linkerd.io/config/_default/params.yaml`: | ||
| `latestMajorVersion: "2.19"` | ||
| - Update the `docs` menu in `linkerd.io/config/_default/menu.yaml` to include a | ||
| menu item for `2.19`. | ||
| `latestMajorVersion: "2.20"` | ||
| - Update the `docs` menu in `linkerd.io/config/_default/menu.yaml` changing the | ||
| 2.19 `pageRef` to `/2.19/`. Then include a new menu item for `2.20` with | ||
| `pageRef` set to `/docs/`. | ||
| - Make sure all the links in the edge version (`2-edge`) are relative and don't | ||
| have the version hard-coded. E.g. `(/../cli/install/#)` instead of | ||
| `(/2-edge/reference/cli/install/#)`. | ||
| - Add a row to the Supported Kubernetes Versions table for `2.19` in | ||
| - Add a row to the Supported Kubernetes Versions table for `2.20` in | ||
| `linkerd.io/content/2-edge/reference/k8s-versions.md`. | ||
| - Create an entire new directory, copying the edge docs: | ||
| `cp -r linkerd.io/content/2-edge linkerd.io/content/2.19`. Any upcoming doc | ||
| changes pertaining to `2.19` should be pushed against that new directory and | ||
| - Add a row to the Gateway API compatibility table for `2.20` in | ||
| `linkerd.io/content/2-edge/features/gateway-api.md`. | ||
| - Rename the `docs` directory `2.19`. | ||
| - Create a new directory, copying the edge docs: | ||
| `cp -r linkerd.io/content/2-edge linkerd.io/content/docs`. Any upcoming doc | ||
| changes pertaining to `2.20` should be pushed against that new directory and | ||
| the `2-edge` directory. | ||
| - Generate the CLI docs with `linkerd doc > linkerd.io/data/cli/2-19.yaml`. Just | ||
| - Generate the CLI docs with `linkerd doc > linkerd.io/data/cli/2-20.yaml`. Just | ||
| to make sure the edge data is up to date, copy the contents from this newly | ||
| genereated file to `linkerd.io/data/cli/2-edge.yaml`. | ||
| - Push, and hold the merge till after `2.19` is out. | ||
| - After merging, update the Cloudflare redirection rule so `/2` points to | ||
| `/2.19`: | ||
| - Click on the `linkerd.io` site | ||
| - Click on the `Rules`section | ||
| - Update the rule `https://linkerd.io/2/*` so that it points to | ||
| `https://linkerd.io/2.19/$1` | ||
| - Push, and hold the merge till after `2.20` is out. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is there a step we need in here to make the per-file 2.20 -> docs redirects? Or is that only needed as a one-time thing for 2.19?
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. All of the {latestVersion} -> docs redirects are generated at build time. You can see this in alias-latest-docs.html (or am I not understanding your question?) |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="{{ site.Language.LanguageCode }}"> | ||
| <head> | ||
| <title>{{ .Permalink }}</title> | ||
| <link rel="canonical" href="{{ .Permalink }}"> | ||
| <meta name="robots" content="noindex"> | ||
| <meta charset="utf-8"> | ||
| <meta http-equiv="refresh" content="0; url={{ .Permalink }}"> | ||
| <script> | ||
| window.location.href = '{{ .Permalink }}' + window.location.hash; | ||
| </script> | ||
| </head> | ||
| </html> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,5 +7,5 @@ cascade: | |
| type: _default | ||
| layout: redirect | ||
| params: | ||
| redirect: ./overview | ||
| redirect: ./getting-started | ||
| --- | ||
Uh oh!
There was an error while loading. Please reload this page.