Merge updated 'main'.

.github/workflows/automatic-doc-checks.yml

@@ -0,0 +1,22 @@
+name: Main Documentation Checks
+
+on:
+  pull_request:
+    paths:
+      - 'doc/**'
+  push:
+    paths:
+      - 'doc/**'
+  workflow_dispatch:
+    paths:
+      - 'doc/**'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true  
+
+jobs:
+  documentation-checks:
+    uses: canonical/documentation-workflows/.github/workflows/documentation-checks.yaml@main
+    with:
+      working-directory: 'doc'

DESIGN.md

@@ -521,7 +521,7 @@ Tests (and lint checks) are run by github actions using lxd.  See
 `.github/workflows/build.yaml` and `./scripts/test-in-lxd.sh` and so
 on.
 
-For "real" testing, you need to make a snap (`snapcraft snap`), mash
+For "real" testing, you need to make a snap (`snapcraft pack`), mash
 it into an existing ISO using `./scripts/inject-subiquity-snap.sh`,
 and boot the result in a VM. There is an even hackier pair of scripts
 (`./scripts/slimy-update-snap.sh` and

README.md

@@ -59,10 +59,41 @@ an ISO. Rather than building one from scratch, it's much easier to
 install your version of subiquity into the daily image. Here's how to
 do this:
 
-1. Build your change into a snap:
+## Commit your changes locally
+
+If you are only making a change in Subiquity itself, running `git add <modified-file...>`
+and then `git commit` should be enough.
+
+Otherwise, if you made any modification to curtin or probert, you need to ensure that:
+
+* The modification is committed inside the relevant repository (i.e., `git add` + `git commit`).
+* The relevant `source` property in snapcraft.yaml points to the local
+  repository instead of the upstream repository.
+* The relevant `source-commit` property in snapcraft.yaml is updated to reflect
+  your new revision (one must use the full SHA-1 here).
+* The above modifications to snapcraft.yaml are committed.
+
+Example:
+```
+parts:
+  curtin:
+    plugin: nil
+
+    # Comment out the original source property, pointing to the upstream repository
+    #source: https://git.launchpad.net/curtin
+    # Instead, specify the name of the directory where curtin is checked out
+    source: curtin
+    source-type: git
+    # Update the below so it points to the commit ID within the curtin repository
+    source-commit: 7c18bf6a24297ed465a341a1f53875b61c878d6b
+```
+
+## Build and inject your changes into an ISO
+
+1. Build your changes into a snap:
 
    ```
-   $ snapcraft snap --output subiquity_test.snap
+   $ snapcraft pack --output subiquity_test.snap
    ```
 
 2. Grab the current version of the installer:

doc/.custom_wordlist.txt

@@ -0,0 +1,80 @@
+Autoinstall
+Autoinstalls
+Btrfs
+DHCP
+EFI
+Esc
+ESP
+ESPs
+GPT
+GUID
+GiB
+GiB
+Libera
+LPAR
+LTS
+LUKS
+LV
+LVM
+LinuxONE
+MiB
+NIC
+Netplan
+NoCloud
+OEM
+OpenSSH
+Petitboot
+PgDown
+PgUp
+POST
+PPA
+PReP
+SSD
+Seagate
+Subiquity
+UEFI
+URI
+Zdev
+amd
+authorized-keys
+autoinstall
+autoinstaller
+autoinstalls
+bootable
+bootloader
+bootloaders
+codecs
+config
+curtin
+debconf
+debian-installer
+el
+flavor
+geoip
+globbing
+hostname
+iSCSI
+init
+md
+oem
+passwd
+ppc
+pre
+preseed
+preseeded
+preseeding
+preseeds
+pw
+realname
+rootfs
+rsyslog
+subvolume
+subvolumes
+superset
+traceback
+tty
+ubuntu
+udev
+unformatted
+VLAN
+webhook

doc/.sphinx/_static/github_issue_links.js

@@ -11,18 +11,7 @@ window.onload = function() {
     link.classList.add("muted-link");
     link.classList.add("github-issue-link");
     link.text = "Give feedback";
-    link.href = (
-        github_url
-        + "/issues/new?"
-        + "title=docs%3A+TYPE+YOUR+QUESTION+HERE"
-        + "&body=*Please describe the question or issue you're facing with "
-        + `"${document.title}"`
-        + ".*"
-        + "%0A%0A%0A%0A%0A"
-        + "---"
-        + "%0A"
-        + `*Reported+from%3A+${location.href}*`
-    );
+    link.href = ("https://bugs.launchpad.net/subiquity/+filebug");
     link.target = "_blank";
 
     const div = document.createElement("div");

doc/.sphinx/_templates/footer.html

@@ -84,7 +84,7 @@
 
     {% if github_issues %}
     <div class="issue-github">
-      <a class="muted-link" href="{{ github_url }}/issues/new?title=doc%3A+ADD+A+TITLE&body=DESCRIBE+THE+ISSUE%0A%0A---%0ADocument: {{ pagename }}{{ page_source_suffix }}">Open a GitHub issue for this page</a>
+      <a class="muted-link" href="https://bugs.launchpad.net/subiquity/+filebug">Open a Launchpad issue for this documentation</a>
     </div>
     {% endif %}
 

doc/.sphinx/_templates/header.html

@@ -7,7 +7,7 @@
       <li>
         <a class="p-logo" href="https://{{ product_page }}" aria-current="page">
           <img src="{{ pathto(product_tag,1) }}" alt="Logo" class="p-logo-image">
-          <div class="p-logo-text p-heading--4">{{ project }}
+          <div class="p-logo-text p-heading--4">{{ project.title() }}
           </div>
         </a>
       </li>

doc/.wordlist.txt

@@ -1,37 +1,39 @@
-addons
+
 API
 APIs
-balancer
-Charmhub
 CLI
-dropdown
+Charmhub
 Diátaxis
 EBS
 EKS
-favicon
 Grafana
 IAM
-installable
 JSON
+Jira
 Juju
-Kubernetes
 Kubeflow
+Kubernetes
 Makefile
 MyST
-namespace
-namespaces
 NodePort
-observability
 OLM
 Permalink
+RTD
 ReadMe
+UI
+VM
+YAML
+addons
+balancer
+boolean
+dropdown
+favicon
+installable
+namespace
+namespaces
+observability
 reST
 reStructuredText
-RTD
 subdirectories
-subtree
 subfolders
-UI
-Jira
-VM
-YAML
+subtree

doc/Makefile

@@ -55,7 +55,7 @@ linkcheck:
 	. $(VENV) ; $(SPHINXBUILD) -c . -b linkcheck  "$(SOURCEDIR)" "$(BUILDDIR)"
 
 woke:
-	type woke >/dev/null 2>&1 || { sudo snap install woke; exit 1; }
+	type woke >/dev/null 2>&1 || { sudo snap install woke || exit 1; }
 	woke *.rst **/*.rst -c https://github.com/canonical-web-and-design/Inclusive-naming/raw/main/config.yml
 
 .PHONY: help Makefile

doc/custom_conf.py

@@ -15,7 +15,7 @@
 ############################################################
 
 # Product name
-project = 'Ubuntu Install Guide'
+project = 'Ubuntu installation'
 author = 'Canonical Group Ltd'
 
 # Uncomment if your product uses release numbers
@@ -41,7 +41,7 @@
 # The URL of the documentation output
 ogp_site_url = 'https://canonical-subiquity.readthedocs-hosted.com/'
 # The documentation website name (usually the same as the product name)
-ogp_site_name = project
+ogp_site_name = 'Ubuntu Installation Guide'
 # An image or logo that is used in the preview
 ogp_image = 'https://assets.ubuntu.com/v1/253da317-image-document-ubuntudocs.svg'
 
@@ -53,7 +53,7 @@
 html_context = {
 
     # Change to the link to your product website (without "https://")
-    'product_page': 'documentation.ubuntu.com',
+    'product_page': 'ubuntu.com/download',
 
     # Add your product tag to ".sphinx/_static" and change the path
     # here (start with "_static"), default is the circle of friends
@@ -62,7 +62,7 @@
     # Change to the discourse instance you want to be able to link to
     # using the :discourse: metadata at the top of a file
     # (use an empty value if you don't want to link)
-    'discourse': 'https://discourse.ubuntu.com',
+    'discourse': 'https://discourse.ubuntu.com/c/foundations/',
 
     # Change to the GitHub info for your project
     'github_url': 'https://github.com/canonical/subiquity',
@@ -76,7 +76,7 @@
 
     # Change to an empty value if your GitHub repo doesn't have issues enabled.
     # This will disable the feedback button and the issue link in the footer.
-    'github_issues': '',
+    'github_issues': 'https://bugs.launchpad.net/subiquity',
 
     # Controls the existence of Previous / Next buttons at the bottom of pages
     # Valid options: none, prev, next, both

doc/explanation/configure-storage.rst

@@ -81,9 +81,9 @@ Logical Volume Manager (LVM)
 .. image:: figures/configure-storage-lvm.png
    :alt:
 
-The LVM is a system of managing logical volumes, or filesystems, that is much
+The LVM is a system of managing logical volumes, or file systems, that is much
 more advanced and flexible than the traditional method of partitioning a disk
-into one or more segments and formatting that partition with a filesystem. It
+into one or more segments and formatting that partition with a file system. It
 can be used to combine several disks into one larger pool of storage but it
 offers advantages even in a single disk system, such as snapshots and easy
 resizing of logical volumes.
@@ -113,7 +113,7 @@ but this can be changed later.
 
 On amd64 and arm64 systems, multiple disks can be selected as boot devices,
 which means a system can be configured so that it will continue to boot after
-a failure of any one drive (assuming the root filesystem is placed on a RAID).
+a failure of any one drive (assuming the root file system is placed on a RAID).
 The bootloader will be installed to each of these drives, and the operating
 system configured to install new versions of GRUB to each drive as it is
 updated.
@@ -151,8 +151,8 @@ operating system. One of the ESPs must be mounted at ``/boot/efi``.
 Supported arm64 servers boot using UEFI, and are configured the same way as an
 UEFI-booting amd64 system.
 
-ppc64el systems also load their bootloader (Petitboot, a small linux kernel)
-from a "PReP" partition with a special flag, so in most ways they are similar
+ppc64el systems also load their bootloader (Petitboot, a small Linux kernel)
+from a PReP (PowerPC Reference Platform) partition with a special flag, so in most ways they are similar
 to a UEFI system. The installer only supports one PReP partition at this time.
 
 Limitations and workarounds
@@ -173,4 +173,4 @@ with desired parameters, and then select these partitions or devices as mount
 points in the installer. Any changes you make while the installer is running
 but before altering the storage configuration will reflected in the installer.
 
-The installer cannot yet configure iSCSI mounts or btrfs subvolumes.
+The installer cannot yet configure iSCSI mounts or BTRFS subvolumes.