diff --git a/doc/custom_conf.py b/doc/custom_conf.py index 3793db79..284a49e3 100644 --- a/doc/custom_conf.py +++ b/doc/custom_conf.py @@ -122,6 +122,7 @@ custom_linkcheck_anchors_ignore_for_url = [ # Add extensions custom_extensions = [ 'sphinx.ext.intersphinx', + 'sphinx.ext.extlinks' ] # Add files or directories that should be excluded from processing. @@ -172,3 +173,7 @@ root_doc = 'index' # 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', '' ) +} diff --git a/doc/explanation/operate-server-installer.rst b/doc/explanation/operate-server-installer.rst index 95e725f1..b7c6b57c 100644 --- a/doc/explanation/operate-server-installer.rst +++ b/doc/explanation/operate-server-installer.rst @@ -5,7 +5,7 @@ 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 `_. +`screen-by-screen reference guide `_. Get the installer ================= diff --git a/doc/index.rst b/doc/index.rst index 79586604..7b51b7bb 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -83,7 +83,7 @@ constructive feedback. development/index .. Links: -.. _Code of Conduct: https://ubuntu.com/community/code-of-conduct +.. _Code of Conduct: https://ubuntu.com/community/ethos/code-of-conduct .. _Ubuntu Foundations: https://discourse.ubuntu.com/c/foundations/ .. _Libera.Chat: https://libera.chat/ .. _CONTRIBUTING.md: https://github.com/canonical/subiquity/blob/main/CONTRIBUTING.md diff --git a/doc/reference/autoinstall-reference.rst b/doc/reference/autoinstall-reference.rst index 51e8d10e..9ee65801 100644 --- a/doc/reference/autoinstall-reference.rst +++ b/doc/reference/autoinstall-reference.rst @@ -144,8 +144,7 @@ installed will not have a keyboard at all in which case the value used here does not matter. The mapping's keys correspond to settings in the :file:`/etc/default/keyboard` -configuration file. See -`its manual page `_ +configuration file. See the :manualpage:`keyboard(5) manual page ` for more details. The mapping contains keys: @@ -635,10 +634,9 @@ password The password for the new user, encrypted. This is required for use with ``sudo``, even if SSH access is configured. -The crypted password string must conform to what -`passwd `_ -expects. Depending on the special characters in the password hash, quoting may -be required, so it's safest to just always include the quotes around the hash. +The crypted password string must conform to what the +``passwd`` command requires. See the :manualpage:`passwd(1) manual page ` +for details. Quote the password hash to ensure correct treatment of any special characters. Several tools can generate the crypted password, such as ``mkpasswd`` from the ``whois`` package, or ``openssl passwd``. diff --git a/doc/tutorial/basic-server-installation.rst b/doc/tutorial/basic-server-installation.rst index 19c657c3..a3c39f91 100644 --- a/doc/tutorial/basic-server-installation.rst +++ b/doc/tutorial/basic-server-installation.rst @@ -65,7 +65,7 @@ Create a bootable USB There are many ways to boot the installer but the simplest and most common way is to -`create a bootable USB stick `_ +`create a bootable USB stick `_ to boot the system to be installed with (`tutorials for other operating systems `_ are also available). diff --git a/doc/tutorial/screen-by-screen.rst b/doc/tutorial/screen-by-screen.rst index 4afdf9e1..aa6243ff 100644 --- a/doc/tutorial/screen-by-screen.rst +++ b/doc/tutorial/screen-by-screen.rst @@ -15,7 +15,7 @@ This screen selects the language for the installer and the default language for the installed system. More languages can be displayed if you -`connect via SSH `_. +`connect via SSH `_. Refresh =======