Merge remote-tracking branch 'upstream/main' into FR-5662_docs-checks

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,38 @@
-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
+dropdown
+favicon
+installable
+namespace
+namespaces
+observability
 reST
 reStructuredText
-RTD
 subdirectories
-subtree
 subfolders
-UI
-Jira
-VM
-YAML
+subtree

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
@@ -122,6 +122,7 @@
 # Add extensions
 custom_extensions = [
     'sphinx.ext.intersphinx',
+    'sphinx.ext.extlinks'
 ]
 
 # Add files or directories that should be excluded from processing.
@@ -172,3 +173,7 @@
 # can be copied even if they don't contain an EOF line.
 copybutton_prompt_text = '$ '
 copybutton_only_copy_prompt_lines = False
+
+extlinks = {
+    'manualpage': ( 'https://manpages.ubuntu.com/manpages/lunar/en/%s', '' )
+}

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.

doc/explanation/operate-server-installer.rst

@@ -5,20 +5,20 @@ Operating the Server installer
 
 This document explains how to use the installer in general terms. For a
 step-by-step guide through the screens of the installer, you can use our
-`screen-by-screen reference guide <https://discourse.ubuntu.com/t/draft-using-the-server-installer-step-by-step/16690>`_.
+`screen-by-screen reference guide <https://discourse.ubuntu.com/t/screen-by-screen-installer-guide/16690>`_.
 
 Get the installer
 =================
 
-Installer images are made (approximately) daily and are available from
-https://cdimage.ubuntu.com/ubuntu-server/daily-live/current/. These are not
+Installer images are created (approximately) daily and are available from the
+`Ubuntu release <https://cdimage.ubuntu.com/ubuntu-server/daily-live/current/>`_ page. These are not
 tested as extensively as the images from release day, but they contain the
-latest packages and installer, so fewer updates will be required during or
+latest packages and installer, so fewer updates are required during or
 after installation.
 
-You can download the server installer for amd64 from
-https://ubuntu.com/download/server and other architectures from
-http://cdimage.ubuntu.com/releases/20.04/release/.
+You can download the server installer for amd64 from the
+`Ubuntu Server <https://ubuntu.com/download/server>`_ page and other architectures from the
+`release directory <http://cdimage.ubuntu.com/releases/20.04/release/>`_.
 
 Installer UI navigation
 =======================
@@ -30,8 +30,8 @@ and :kbd:`space` or :kbd:`Enter` keys and a little typing.
 :kbd:`Home` / :kbd:`End` / :kbd:`Page Up` / :kbd:`Page Down` can be used to
 navigate through long lists more quickly in the usual way.
 
-Running the installer over serial
-=================================
+Running the installer over a serial port
+========================================
 
 By default, the installer runs on the first virtual terminal, ``tty1``. This
 is what is displayed on any connected monitor by default. However, servers do
@@ -42,10 +42,10 @@ the serial port. To do this, the kernel command line needs to
 specified on it -- a common value is ``console=ttyS0`` but this is not
 something that can be generically documented.
 
-When running on serial, the installer starts in a basic mode that uses only
+When running on a serial port, the installer starts in a basic mode that uses only
 the ASCII character set and black and white colours. If you are connecting from
-a terminal emulator such as gnome-terminal that supports Unicode and rich
-colours you can switch to "rich mode" which uses Unicode, colours and supports
+a terminal emulator, such as gnome-terminal, that supports Unicode and rich
+colours, you can switch to "rich mode" which uses Unicode and colours, and supports
 many languages.
 
 .. _connect-via-ssh:
@@ -88,7 +88,7 @@ There are some global keys you can press at any time:
 ====================================  =============================================
 Key                                   Action
 ====================================  =============================================
-:kbd:`ESC`                            Go back
+:kbd:`Esc`                            Go back
 :kbd:`F1`                             Open help menu
 :kbd:`Control` + :kbd:`Z`, :kbd:`F2`  Switch to shell
 :kbd:`Control` + :kbd:`L`, :kbd:`F3`  Redraw screen

doc/howto/autoinstall-quickstart-s390x.rst

@@ -26,8 +26,8 @@ Mount the ISO
     mkdir -p ~/iso
     sudo mount -r ~/Downloads/ubuntu-|ubuntu-latest-version|-live-server-s390x.iso ~/iso
 
-Write your autoinstall config
-=============================
+Write your autoinstall configuration
+====================================
 
 Create a cloud-init configuration:
 
@@ -46,10 +46,10 @@ Create a cloud-init configuration:
     EOF
     touch meta-data
 
-The crypted password is ``ubuntu``.
+The encrypted password is ``ubuntu``.
 
-Serve the cloud-init config over HTTP
-=====================================
+Serve the cloud-init configuration over HTTP
+============================================
 
 Leave this running in one terminal window: