Skip to content

Commit 3f668ce

Browse files
authored
Change all paths to /charmed-k8s/docs (#897)
* change all paths to /charmed-k8s/docs Ubuntu.com moved our docs under /kubernetes/charmed-k8s/docs from /kubernetes/docs . This PR updates our version of the docs to better match ubunutu.com and make commiting to ubuntu.com easier * Add missing updates * Make diff as small as possible Making small changes to make the diff between ubuntu.com version of our docs and our version as small as possible * inclusive language fix
1 parent 8e60b95 commit 3f668ce

File tree

316 files changed

+1789
-1716
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

316 files changed

+1789
-1716
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This is a repository for iterating on new versions of the Charmed Kubernetes docs.
44
This official docs are published at :
5-
[https://www.ubuntu.com/kubernetes/docs](https://www.ubuntu.com/kubernetes/docs)
5+
[https://www.ubuntu.com/kubernetes/charmed-k8s/docs](https://www.ubuntu.com/kubernetes/charmed-k8s/docs)
66

77
This repository is set to live publish at:
88
[https://cdk-docs.netlify.app/](https://cdk-docs.netlify.app/)

_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ description: > # this means to ignore newlines until "baseurl:"
3030
line in _config.yml. It will appear in your document head meta (for
3131
Google search results) and in your feed.xml site description.
3232
url: https://www.ubuntu.com
33-
baseurl: /kubernetes/docs
33+
baseurl: /kubernetes/charmed-k8s/docs
3434
github_username: jekyll
3535
defaults:
3636
-

_layouts/ubuntu-com.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{% raw %}{% extends "kubernetes/docs/base_docs.html" %}{% endraw %}
1+
{% raw %}{% extends "kubernetes/charmed-k8s/docs/base_docs.html" %}{% endraw %}
22

33
{% raw %}{% block meta_description %}{% endraw %}
44
{{ summary | strip_html }}

generator/k8s_docs_tools/templates/component.j2

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
wrapper_template: "templates/docs/markdown.html"
33
markdown_includes:
4-
nav: kubernetes/docs/shared/_side-navigation.md
4+
nav: kubernetes/charmed-k8s/docs/shared/_side-navigation.md
55
context:
66
title: Components of Charmed Kubernetes {{ release }}
77
description: Detailed description of Charmed Kubernetes release
@@ -19,17 +19,17 @@ toc: false
1919

2020
<!-- THIS PAGE IS AUTOGENERATED -->
2121
<!-- If you find an error in this page, it is likely to be in the original
22-
source of the information - please file a bug at
23-
https://github.com/charmed-kubernetes/kubernetes-docs/issues
22+
source of the information - please file a bug at
23+
https://github.com/charmed-kubernetes/kubernetes-docs/issues
2424
rather than editing the text -->
2525

2626
This page details the charms and container images
2727
which comprise the {{release}} release of Charmed Kubernetes.
2828

2929
Other information about this release can be found on the following pages:
3030

31-
<a class='p-button--brand' href='/kubernetes/docs/{{release}}/release-notes'>Release notes </a>
32-
<a class='p-button--brand' href='/kubernetes/docs/{{release}}/upgrading'>Upgrading </a>
31+
<a class='p-button--brand' href='/kubernetes/charmed-k8s/docs/{{release}}/release-notes'>Release notes </a>
32+
<a class='p-button--brand' href='/kubernetes/charmed-k8s/docs/{{release}}/upgrading'>Upgrading </a>
3333
<a class='p-button--brand' href='https://bugs.launchpad.net/charmed-kubernetes'>Bugs </a>
3434
<a class='p-button--brand' href='https://github.com/charmed-kubernetes/bundle'>Source </a>
3535
<a class='p-button--brand' href='https://launchpad.net/charmed-kubernetes/+milestone/{{release}}'>Milestone </a>
@@ -96,9 +96,9 @@ These are the container images used by this release:
9696

9797
<!-- LINKS -->
9898

99-
[release notes]: /kubernetes/docs/release-notes#{{release}}
100-
[upgrade notes]: /kubernetes/docs/upgrade-notes
101-
[bugs]: /kubernetes/docs/
99+
[release notes]: /kubernetes/charmed-k8s/docs/release-notes#{{release}}
100+
[upgrade notes]: /kubernetes/charmed-k8s/docs/upgrade-notes
101+
[bugs]: /kubernetes/charmed-k8s/docs/
102102
[source]: https://github.com/charmed-kubernetes
103103
[{{release}} milestone]: https://launchpad.net/charmed-kubernetes/+milestone/{{release}}
104104

@@ -109,7 +109,7 @@ These are the container images used by this release:
109109
<a href="https://github.com/charmed-kubernetes/kubernetes-docs/edit/main/pages/k8s/{{ release }}/components.md" >edit this page</a>
110110
or
111111
<a href="https://github.com/charmed-kubernetes/kubernetes-docs/issues/new">file a bug here</a>.</p>
112-
<p>See the guide to <a href="/kubernetes/docs/how-to-contribute"> contributing </a> or discuss these docs in our <a href="https://chat.charmhub.io/charmhub/channels/kubernetes"> public Mattermost channel</a>.</p>
112+
<p>See the guide to <a href="/kubernetes/charmed-k8s/docs/how-to-contribute"> contributing </a> or discuss these docs in our <a href="https://chat.charmhub.io/charmhub/channels/kubernetes"> public Mattermost channel</a>.</p>
113113
</div>
114114
</div>
115115

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
<!--LINKS-->
22

3-
[rel]: /kubernetes/docs/release-notes
3+
[rel]: /kubernetes/charmed-k8s/docs/release-notes

generator/k8s_docs_tools/templates/release-notes-header.j2

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
wrapper_template: templates/docs/markdown.html
33
markdown_includes:
4-
nav: kubernetes/docs/shared/_side-navigation.md
4+
nav: kubernetes/charmed-k8s/docs/shared/_side-navigation.md
55
context:
66
title: {{ release }} Release notes
77
description: Release notes for Charmed Kubernetes
88
keywords: kubernetes, release, notes
9-
tags:
9+
tags:
1010
- news
1111
sidebar: k8smain-sidebar
1212
permalink: {{ release }}/release-notes.html

generator/k8s_docs_tools/templates/supported-versions.j2

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
wrapper_template: "templates/docs/markdown.html"
33
markdown_includes:
4-
nav: "kubernetes/docs/shared/_side-navigation.md"
4+
nav: "kubernetes/charmed-k8s/docs/shared/_side-navigation.md"
55
context:
66
title: "Supported versions"
77
description: The Charmed Kubernetes release cycle and current supported versions.
@@ -15,8 +15,8 @@ toc: False
1515

1616
<!-- THIS PAGE IS AUTOGENERATED -->
1717
<!-- If you find an error in this page, it is likely to be in the original
18-
source of the information - please file a bug at
19-
https://github.com/charmed-kubernetes/kubernetes-docs/issues
18+
source of the information - please file a bug at
19+
https://github.com/charmed-kubernetes/kubernetes-docs/issues
2020
rather than editing the text -->
2121

2222
Charmed Kubernetes officially supports the three most recent minor releases
@@ -25,12 +25,12 @@ fully on the [Ubuntu release cycle page](/about/release-cycle#canonical-kubernet
2525

2626
Current release: **{{ release }}**
2727

28-
Supported releases (click buttons for more information):
28+
Supported releases (click buttons for more information):
2929

3030
<div class="row">
3131
{%- for rel in supported_releases %}
3232
<div class="col-2">
33-
<span class="u-vertically-center"><a href="/kubernetes/docs/{{rel}}/components" class="p-button--positive">{{rel}}.x</a></span>
33+
<span class="u-vertically-center"><a href="/kubernetes/charmed-k8s/docs/{{rel}}/components" class="p-button--positive">{{rel}}.x</a></span>
3434
</div>
3535
{%- endfor %}
3636
</div>
@@ -86,7 +86,7 @@ professional support programmes.
8686
<a href="https://github.com/charmed-kubernetes/kubernetes-docs/edit/main/pages/k8s/supported-versions.md" >edit this page</a>
8787
or
8888
<a href="https://github.com/charmed-kubernetes/kubernetes-docs/issues/new">file a bug here</a>.</p>
89-
<p>See the guide to <a href="/kubernetes/docs/how-to-contribute"> contributing </a> or discuss these docs in our <a href="https://chat.charmhub.io/charmhub/channels/kubernetes"> public Mattermost channel</a>.</p>
89+
<p>See the guide to <a href="/kubernetes/charmed-k8s/docs/how-to-contribute"> contributing </a> or discuss these docs in our <a href="https://chat.charmhub.io/charmhub/channels/kubernetes"> public Mattermost channel</a>.</p>
9090
</div>
9191
</div>
9292

generator/k8s_docs_tools/templates/upgrading.j2

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
wrapper_template: "templates/docs/markdown.html"
33
markdown_includes:
4-
nav: "kubernetes/docs/shared/_side-navigation.md"
4+
nav: "kubernetes/charmed-k8s/docs/shared/_side-navigation.md"
55
context:
66
title: "Upgrading to {{ release }}"
77
description: How to upgrade your version of Charmed Kubernetes.
@@ -376,13 +376,13 @@ It is recommended that you run a [cluster validation][validation] to ensure that
376376
<!--LINKS-->
377377

378378
[k8s-release]: https://github.com/kubernetes/kubernetes/releases
379-
[backups]: /kubernetes/docs/backups
380-
[release-notes]: /kubernetes/docs/release-notes
381-
[notes]: /kubernetes/docs/upgrade-notes
379+
[backups]: /kubernetes/charmed-k8s/docs/backups
380+
[release-notes]: /kubernetes/charmed-k8s/docs/release-notes
381+
[notes]: /kubernetes/charmed-k8s/docs/upgrade-notes
382382
[snap-channels]: https://docs.snapcraft.io/reference/channels
383383
[blue-green]: https://martinfowler.com/bliki/BlueGreenDeployment.html
384-
[validation]: /kubernetes/docs/validation
385-
[supported-versions]: /kubernetes/docs/supported-versions
384+
[validation]: /kubernetes/charmed-k8s/docs/validation
385+
[supported-versions]: /kubernetes/charmed-k8s/docs/supported-versions
386386

387387
<!-- FEEDBACK -->
388388
<div class="p-notification--information">
@@ -391,7 +391,7 @@ It is recommended that you run a [cluster validation][validation] to ensure that
391391
<a href="https://github.com/charmed-kubernetes/kubernetes-docs/edit/main/pages/k8s/{{ release }}/upgrading.md" >edit this page</a>
392392
or
393393
<a href="https://github.com/charmed-kubernetes/kubernetes-docs/issues/new">file a bug here</a>.</p>
394-
<p>See the guide to <a href="/kubernetes/docs/how-to-contribute"> contributing </a> or discuss these docs in our <a href="https://chat.charmhub.io/charmhub/channels/kubernetes"> public Mattermost channel</a>.</p>
394+
<p>See the guide to <a href="/kubernetes/charmed-k8s/docs/how-to-contribute"> contributing </a> or discuss these docs in our <a href="https://chat.charmhub.io/charmhub/channels/kubernetes"> public Mattermost channel</a>.</p>
395395
</div>
396396
</div>
397397

index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
wrapper_template: "base-docs.html"
33
markdown_includes:
4-
nav: "shared/_side-navigation.md"
4+
nav: "kubernetes/charmed-k8s/shared/_side-navigation.md"
55
context:
66
title: "Charmed Kubernetes documentation"
77
description: Documentation for the Canonical Distribution of Kubernetes.
@@ -33,12 +33,12 @@ Google, Microsoft, and many other institutions run Kubernetes on Ubuntu because
3333
</thead>
3434
<tbody>
3535
<tr>
36-
<td><a href="/kubernetes/docs/tutorials-index">Tutorials</a><br> Get started with this introduction to Charmed Kubernetes <br></td>
37-
<td><a href="/kubernetes/docs/how-to-index">How-to guides</a> <br> Step-by-step guides covering key operations and common tasks</td>
36+
<td><a href="/kubernetes/charmed-k8s/docs/tutorials-index">Tutorials</a><br> Get started with this introduction to Charmed Kubernetes <br></td>
37+
<td><a href="/kubernetes/charmed-k8s/docs/how-to-index">How-to guides</a> <br> Step-by-step guides covering key operations and common tasks</td>
3838
</tr>
3939
<tr>
40-
<td><a href="/kubernetes/docs/explanation-index">Explanation</a> <br> Concepts - discussion and clarification of key topics</td>
41-
<td><a href="/kubernetes/docs/reference-index">Reference</a> <br> Technical information - specifications, commands, architecture</td>
40+
<td><a href="/kubernetes/charmed-k8s/docs/explanation-index">Explanation</a> <br> Concepts - discussion and clarification of key topics</td>
41+
<td><a href="/kubernetes/charmed-k8s/docs/reference-index">Reference</a> <br> Technical information - specifications, commands, architecture</td>
4242
</tr>
4343
</tbody>
4444
</table>

netlify.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
[[redirects]]
2-
from = "/kubernetes/docs/*"
2+
from = "/kubernetes/charmed-k8s/docs/*"
33
to = "/:splat"
44
status = 200
55
force = false
6-
6+
77
# COMMENT: This a rule for managed kubernetes
88
[[redirects]]
99
from = "/kubernetes/managed"
1010
to = "https://www.ubuntu.com/kubernetes/managed"
1111
status = 200
1212
force = false
13-
13+
1414
# COMMENT: This a rule for support
1515
[[redirects]]
1616
from = "/support"

0 commit comments

Comments
 (0)