Skip to content
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.

Sign up for GitHub

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

Refactor Quicklinks section in documentation for further localization #1643

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Refactor Quicklinks section in documentation for further localization #1643

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5d8ece
Refactor Quicklinks section in documentation for further localization
Andygol Nov 12, 2024
77598f0
Replace i18n function with T for quick links localization in document…
Andygol Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 0 additions & 25 deletions config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,31 +58,6 @@ url = "https://v2.helm.sh/docs"
version = "v3.17.0"
date = "January 15, 2025"

[[params.quicklinks]]
title = "Quickstart Guide"
description = "How to install and get started with Helm including instructions for distros, FAQs, and plugins."
url = "/docs/intro/quickstart"

[[params.quicklinks]]
title = "Chart Guide"
description = "Practical steps for building Helm charts—how to structure, sign, and sync your charts."
url = "/docs/topics/charts"

[[params.quicklinks]]
title = "Video: Intro to Helm"
description = "Watch Matt Farina and Josh Dolitsky present an introduction to Helm at KubeCon 2019."
url = "https://www.youtube.com/watch?v=Zzwq9FmZdsU"

[[params.quicklinks]]
title = "Migrating from v2 to v3"
description = "Read our blog post on how to migrate from Helm v2 to Helm v3."
url = "/blog/migrate-from-helm-v2-to-helm-v3/"

[[params.quicklinks]]
title = "Helm Security Audit"
description = "Helm has been audited and deemed as recommended for public deployment during a third-party security audit funded by the CNCF."
url = "/blog/2019-11-04-helm-security-audit-results/"

# Multilingual configuration
defaultContentLanguage = "en"
disableLanguages = ["zh"]
Expand Down
41 changes: 40 additions & 1 deletion i18n/en.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ other = "What is Helm?"

[main_what_is_helm_description]
other = """
Helm helps you manage Kubernetes applications — Helm Charts help you define, install, and upgrade even the most complex Kubernetes application.
Helm helps you manage Kubernetes applications — Helm Charts help you define, install, and upgrade even the most complex Kubernetes application.

Charts are easy to create, version, share, and publish — so start using Helm and stop the copy-and-paste.

Expand Down Expand Up @@ -221,3 +221,42 @@ other = "**404** **Page not found.**"

[404_subtitle]
other = "Sorry about that. If something is broken please [report it here](https://github.com/helm/helm-www/issues/new)."

# quicklinks section
[quicklinks_section_title]
other = "Quicklinks"

[quicklink_quickstart_title]
other = "Quickstart Guide"
[quicklink_quickstart_desc]
other = "How to install and get started with Helm including instructions for distros, FAQs, and plugins."
[quicklink_quickstart_url]
other = "/docs/intro/quickstart"

[quicklink_charts_title]
other = "Chart Guide"
[quicklink_charts_desc]
other = "Practical steps for building Helm charts—how to structure, sign, and sync your charts."
[quicklink_charts_url]
other = "/docs/topics/charts"

[quicklink_video_intro_title]
other = "Video: Intro to Helm"
[quicklink_video_intro_desc]
other = "Watch Matt Farina and Josh Dolitsky present an introduction to Helm at KubeCon 2019."
[quicklink_video_intro_url]
other = "https://www.youtube.com/watch?v=Zzwq9FmZdsU"

[quicklink_v2_v3_migration_title]
other = "Migrating from v2 to v3"
[quicklink_v2_v3_migration_desc]
other = "Read our blog post on how to migrate from Helm v2 to Helm v3."
[quicklink_v2_v3_migration_url]
other = "/blog/migrate-from-helm-v2-to-helm-v3/"

[quicklink_sec_audit_title]
other = "Helm Security Audit"
[quicklink_sec_audit_desc]
other = "Helm has been audited and deemed as recommended for public deployment during a third-party security audit funded by the CNCF."
[quicklink_sec_audit_url]
other = "/blog/2019-11-04-helm-security-audit-results/"
45 changes: 23 additions & 22 deletions themes/helm/layouts/docs/helm/list.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,31 +23,32 @@
{{ .Content }}

<div class="quick-links helm-commands">
<h3 class="text-center">Quicklinks</h3>
<h3 class="text-center">{{ T "quicklinks_section_title" }}</h3>

{{ if $isDocsRoot }}
{{ $quicklinks := site.Params.quicklinks }}
{{ range $quicklinks }}
<a href="{{ .url }}" class="quick-item">
<h4>
{{ .title }}
{{ with .via }}
&nbsp;<small><i class="fa fa-external-link"></i></small>
{{ end }}
</h4>
<p>
{{ .description }}
{{ with .via }}
- <small>
(via {{ . }})
</small>
{{ end }}
</p>
<a href="{{ T "quicklink_quickstart_url" }}" class="quick-item">
<h4>{{ T "quicklink_quickstart_title" }}</h4>
<p>{{ T "quicklink_quickstart_desc" }}</p>
</a>
{{ end }}

<a href="{{ T "quicklink_charts_url" }}" class="quick-item">
<h4>{{ T "quicklink_charts_title" }}</h4>
<p>{{ T "quicklink_charts_desc" }}</p>
</a>
<a href="{{ T "quicklink_video_intro_url" }}" class="quick-item">
<h4>{{ T "quicklink_video_intro_title" }}</h4>
<p>{{ T "quicklink_video_intro_desc" }}</p>
</a>
<a href="{{ T "quicklink_v2_v3_migration_url" }}" class="quick-item">
<h4>{{ T "quicklink_v2_v3_migration_title" }}</h4>
<p>{{ T "quicklink_v2_v3_migration_desc" }}</p>
</a>
<a href="{{ T "quicklink_sec_audit_url" }}" class="quick-item">
<h4>{{ T "quicklink_sec_audit_title" }}</h4>
<p>{{ T "quicklink_sec_audit_desc" }}</p>
</a>

{{ else }}

{{ range .Pages }}
<a href="{{ .RelPermalink }}" class="quick-item">
<h4>
Expand Down
44 changes: 22 additions & 22 deletions themes/helm/layouts/docs/list.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,35 +16,35 @@
<aside class="column is-narrow is-gapless sidebar-wrapper">
{{ partial "sidebar.html" . }}
</aside>

<section class="column content-docs">
<article class="content-wrapper">
{{ .Content }}

<section class="quick-links clearfix">
<h3 class="text-center">Quicklinks</h3>
<h3 class="text-center">{{ T "quicklinks_section_title" }}</h3>

{{ if $isDocsRoot }}
{{ $quicklinks := site.Params.quicklinks }}
{{ range $quicklinks }}
<a href="{{ .url }}" class="quick-item clearfix">
<h4>
{{ .title }}
{{ with .via }}
&nbsp;<small><i class="fa fa-external-link"></i></small>
{{ end }}
</h4>
<p>
{{ .description }}
{{ with .via }}
- <small>
(via {{ . }})
</small>
{{ end }}
</p>
<a href="{{ T "quicklink_quickstart_url" }}" class="quick-item clearfix">
<h4>{{ T "quicklink_quickstart_title" }}</h4>
<p>{{ T "quicklink_quickstart_desc" }}</p>
</a>
<a href="{{ T "quicklink_charts_url" }}" class="quick-item clearfix">
<h4>{{ T "quicklink_charts_title" }}</h4>
<p>{{ T "quicklink_charts_desc" }}</p>
</a>
<a href="{{ T "quicklink_video_intro_url" }}" class="quick-item clearfix">
<h4>{{ T "quicklink_video_intro_title" }}</h4>
<p>{{ T "quicklink_video_intro_desc" }}</p>
</a>
<a href="{{ T "quicklink_v2_v3_migration_url" }}" class="quick-item clearfix">
<h4>{{ T "quicklink_v2_v3_migration_title" }}</h4>
<p>{{ T "quicklink_v2_v3_migration_desc" }}</p>
</a>
<a href="{{ T "quicklink_sec_audit_url" }}" class="quick-item clearfix">
<h4>{{ T "quicklink_sec_audit_title" }}</h4>
<p>{{ T "quicklink_sec_audit_desc" }}</p>
</a>
{{ end }}

{{ else }}

{{ range .Pages }}
Expand Down