Skip to content

Commit d98b007

Browse files
smirasmira
committed
feat: reword wizard using GitHub Copilot
Use AI suggestions to improve wording. Drop unused (old) HTML templates. Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
1 parent fe9134a commit d98b007

10 files changed

Lines changed: 35 additions & 222 deletions

File tree

‎internal/frontend/http/templates/common.html‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -107,13 +107,13 @@ <h1 class="mb-4 mt-2 text-2xl font-bold">{{ . }}</h1>
107107

108108
{{ define "arch-description" }}
109109
{{ if eq .Arch "amd64" }}
110-
Intel, AMD CPUs. Also known as x86_64, if unsure, use this option.
111-
{{ end }}
112-
{{ if eq .Arch "arm64" }}
113-
{{ if eq .Target "metal" }}
114-
Ampere Computing and other arm64 CPUs. For Single Board Computers use 'SBC' option on the first screen. For AWS and GCP arm64 VMs use Cloud images.
115-
{{ else }}
116-
Various ARM64 manufacturers, also known as aarch64.
110+
Compatible with Intel and AMD CPUs, also referred to as x86_64. If unsure, select this option.
111+
{{ end }}
112+
{{ if eq .Arch "arm64" }}
113+
{{ if eq .Target "metal" }}
114+
Suitable for Ampere Computing and other arm64 CPUs. For Single Board Computers, choose the 'SBC' option on the first screen. For AWS and GCP arm64 VMs, use Cloud images.
115+
{{ else }}
116+
Compatible with various ARM64 manufacturers, also known as aarch64.
117+
{{ end }}
117118
{{ end }}
118-
{{ end }}
119119
{{ end }}

‎internal/frontend/http/templates/index.html‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,10 @@
1818
<div class="prose dark:prose-invert mt-4">
1919
<h1>Talos Linux Image Factory</h1>
2020
<p>
21-
Talos Linux Image Factory by <a href="https://siderolabs.com/">Sidero Labs, Inc.</a> provides a way
22-
to download various boot assets for <a href="https://talos.dev/">Talos Linux</a>.
21+
The Talos Linux Image Factory, developed by <a href="https://siderolabs.com/">Sidero Labs, Inc.</a>, offers a method to download various boot assets for <a href="https://talos.dev/">Talos Linux</a>.
2322
</p>
2423
<p>
25-
To learn more about the API of the Image Factory and available image formats, please visit <a
26-
href="https://github.com/siderolabs/image-factory">the GitHub repository</a>.
24+
For more information about the Image Factory API and the available image formats, please visit <a href="https://github.com/siderolabs/image-factory">the GitHub repository</a>.
2725
</p>
2826
<p class="tracking-tight text-gray-500 text-xs dark:text-gray-400">
2927
Version: {{ .Version }}

‎internal/frontend/http/templates/schematic-config.html‎

Lines changed: 0 additions & 58 deletions
This file was deleted.

‎internal/frontend/http/templates/schematic.html‎

Lines changed: 0 additions & 124 deletions
This file was deleted.

‎internal/frontend/http/templates/wizard-arch.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<span class="ms-3 text-sm font-medium text-gray-900 dark:text-gray-300">SecureBoot</span>
1313
</label>
1414
<div class="ms-2 text-sm">
15-
<p class="text-xs font-normal text-gray-500 dark:text-gray-300">Generate <a class="text-blue-600 dark:text-blue-500 underline" target="_blank" href="https://www.talos.dev/{{ short_version .Version }}/talos-guides/install/bare-metal-platforms/secureboot/">SecureBoot</a> image signed by the Sidero Labs official signing key. Requires UEFI boot and pre-configured hardware.</p>
15+
<p class="text-xs font-normal text-gray-500 dark:text-gray-300">Create a <a class="text-blue-600 dark:text-blue-500 underline" target="_blank" href="https://www.talos.dev/{{ short_version .Version }}/talos-guides/install/bare-metal-platforms/secureboot/">SecureBoot</a> image signed with the official Sidero Labs signing key. This requires UEFI boot and pre-configured hardware.</p>
1616
</div>
1717
</div>
1818
{{ end }}

‎internal/frontend/http/templates/wizard-cmdline.html‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,16 @@
1515

1616
<div class="ms-2 prose dark:prose-invert prose-sm">
1717
<p>
18-
This step allows to customize the default <a target="_blank" href="https://www.talos.dev/{{ short_version .Version }}/reference/kernel/">kernel command line arguments</a>.
18+
This step allows you to customize the default <a target="_blank" href="https://www.talos.dev/{{ short_version .Version }}/reference/kernel/">kernel command line arguments</a>.
1919
</p>
2020
<p>
21-
The syntax accepted is the same as the kernel command line syntax, e.g. <code>console=ttyS0,115200</code>, but prefixing the argument with <code>-</code> removes the argument from the default command line (e.g. <code>-console</code>).
21+
The syntax accepted is the same as the kernel command line syntax, e.g., <code>console=ttyS0,115200</code>. Prefixing an argument with <code>-</code> removes it from the default command line (e.g., <code>-console</code>).
2222
</p>
2323
{{ if eq .SecureBoot "true" }}
2424
<p>With SecureBoot, the kernel command line is signed and cannot be modified, so this is the only opportunity to customize it.</p>
2525
{{ else }}
2626
<p>
27-
Please note, that the kernel command line customization is only accepted for the initial boot images (ISO, PXE, disk image), and
28-
ignored for <code>installer</code> images. For the upgrade/install command line customization, use the <code>machine.install.extraKernelArgs</code> machine
29-
configuration field.
27+
Please note that kernel command line customization is only accepted for the initial boot images (ISO, PXE, disk image) and is ignored for <code>installer</code> images. For upgrade/install command line customization, use the <code>machine.install.extraKernelArgs</code> machine configuration field.
3028
</p>
3129
{{ end }}
3230
<p>
@@ -47,14 +45,13 @@
4745

4846
<div class="ms-2 prose dark:prose-invert prose-sm">
4947
<p>
50-
This step allows to customize the overlay options for <a target="_blank" href="https://github.com/{{ .BoardMeta.OverlayImage }}">{{ .BoardMeta.OverlayImage }} overlay</a>.
48+
This step allows you to customize the overlay options for the <a target="_blank" href="https://github.com/{{ .BoardMeta.OverlayImage }}">{{ .BoardMeta.OverlayImage }} overlay</a>.
5149
</p>
5250
<p>
53-
The syntax accepted is the YAML (JSON) key-value pairs.
54-
The list of options available is specific to the overlay image used, and can be found in the overlay image documentation.
51+
The accepted syntax is YAML (JSON) key-value pairs. The available options are specific to the overlay image and can be found in its documentation.
5552
</p>
5653
<p>
57-
Skip this step if unsure.
54+
If unsure, you can skip this step.
5855
</p>
5956
</div>
6057
{{ end }}

‎internal/frontend/http/templates/wizard-extensions.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
<div class="mb-6 max-h-[500px] flex flex-col">
55
<div class="ms-2 text-sm">
66
<p class="text-xs font-normal text-gray-500 dark:text-gray-300">
7-
<a class="text-blue-600 dark:text-blue-500 underline" target="_blank" href="https://github.com/siderolabs/extensions">System Extensions</a> extend the Talos Linux base image with additional feature: extra drivers, hardware firmware, container runtimes, guest agents, etc.
7+
<a class="text-blue-600 dark:text-blue-500 underline" target="_blank" href="https://github.com/siderolabs/extensions">System Extensions</a> enhance the Talos Linux base image with additional features such as extra drivers, hardware firmware, container runtimes, guest agents, and more.
88
<br>
9-
Pick the extensions that are required for your environment, skip this step if unsure.
9+
Select the extensions needed for your environment. If unsure, you can skip this step.
1010
</p>
1111
</div>
1212

‎internal/frontend/http/templates/wizard-final.html‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010
<div class="mb-6 prose prose-sm dark:prose-invert max-w-none">
1111
<h2>First Boot</h2>
1212
{{ if eq .Target "metal" }}
13-
<p>There are several options for the initial boot of Talos Linux on bare-metal machine (or generic virtual machine):</p>
13+
<p>Here are the options for the initial boot of Talos Linux on a bare-metal machine or a generic virtual machine:</p>
1414
{{ else if eq .Target "cloud" }}
15-
<p>Options for the initial boot of Talos Linux on {{ .PlatformMeta.Label }}:</p>
15+
<p>Here are the options for the initial boot of Talos Linux on {{ .PlatformMeta.Label }}:</p>
1616
{{ else if eq .Target "sbc" }}
17-
<p>Use the following disk image for {{ .BoardMeta.Label }}:</p>
17+
<p>Use the following disk image for {{ .BoardMeta.Label }}:</p>
1818
{{ end }}
1919
<dl>
2020
{{ if eq .Target "metal" }}
@@ -42,16 +42,16 @@ <h2>First Boot</h2>
4242
</dl>
4343

4444
{{ if or (eq .Target "metal") (and (eq .Target "cloud") .PlatformMeta.NotOnlyDiskImage) }}
45-
<h2>Initial Install</h2>
46-
<p>
47-
For the initial Talos Linux install (doesn't apply to disk image boot) put the following installer image to the machine configuration:<br>
48-
{{ template "installer-image" . }}
49-
</p>
45+
<h2>Initial Installation</h2>
46+
<p>
47+
For the initial installation of Talos Linux (not applicable for disk image boot), add the following installer image to the machine configuration:<br>
48+
{{ template "installer-image" . }}
49+
</p>
5050
{{ end }}
5151

52-
<h2>Talos Linux Upgrade</h2>
52+
<h2>Upgrading Talos Linux</h2>
5353
<p>
54-
Use the following image to <a href="https://www.talos.dev/{{ short_version .Version }}/talos-guides/upgrading-talos/" target="_blank">upgrade</a> Talos Linux on the machine:<br>
54+
To <a href="https://www.talos.dev/{{ short_version .Version }}/talos-guides/upgrading-talos/" target="_blank">upgrade</a> Talos Linux on the machine, use the following image:<br>
5555
{{ template "installer-image" . }}
5656
</p>
5757

‎internal/frontend/http/templates/wizard-start.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{{ define "wizard-start" }}
22
{{ template "header" "Hardware Type" }}
33
<div class="mb-6">
4-
{{ template "radio-with-description" dict "name" "target" "value" "metal" "current" .SelectedTarget "label" "Bare-metal Machine" "description" "x86-64, arm64 bare-metal machines, generic virtual machines. If unsure, use this option." }}
5-
{{ template "radio-with-description" dict "name" "target" "value" "cloud" "current" .SelectedTarget "label" "Cloud Server" "description" "AWS, GCP, Azure, VMWare, Equinix Metal and others, including homelab clouds like Proxmox." }}
6-
{{ template "radio-with-description" dict "name" "target" "value" "sbc" "current" .SelectedTarget "label" "Single Board Computer" "description" "Raspberry Pi, Pine64, Jetson Nano, etc." }}
4+
{{ template "radio-with-description" dict "name" "target" "value" "metal" "current" .SelectedTarget "label" "Bare-metal Machine" "description" "Suitable for x86-64 and arm64 bare-metal machines, as well as generic virtual machines. If unsure, choose this option." }}
5+
{{ template "radio-with-description" dict "name" "target" "value" "cloud" "current" .SelectedTarget "label" "Cloud Server" "description" "Compatible with AWS, GCP, Azure, VMWare, Equinix Metal, and other platforms, including homelab environments like Proxmox." }}
6+
{{ template "radio-with-description" dict "name" "target" "value" "sbc" "current" .SelectedTarget "label" "Single Board Computer" "description" "Supports Raspberry Pi, Pine64, Jetson Nano, and similar devices." }}
77
{{ template "next-button" }}
88
</div>
99
{{ end }}

‎internal/frontend/http/templates/wizard-versions.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818
</select>
1919
<div class="mt-6">
2020
<p class="text-xs font-normal text-gray-500 dark:text-gray-300">
21-
It is always recommended to run the latest stable version of Talos Linux ({{ .Versions.LatestStable }}).
22-
<br>
23-
Pre-release versions can be used for testing, but not recommended for production use.
21+
We strongly recommend using the latest stable version of Talos Linux ({{ .Versions.LatestStable }}).
22+
<br>
23+
Pre-release versions are suitable for testing purposes but are not advised for production environments.
2424
</p>
2525
</div>
2626
<div class="mt-6" id="version-doc">

0 commit comments

Comments
 (0)