Commit Graph

87 Commits

Author SHA1 Message Date
Chris Peterson f3e1d6977e doc: autoinstall release notes pictures 2024-04-24 16:34:30 -07:00
Dan Bungert 2afd7f2fa5 doc: fix indent in reference of codecs.install 2024-04-21 18:08:49 -06:00
Olivier Gayot 01338fae05 mirror: switch default policy to OFFLINE_INSTALL by default
Automated installations and desktop installations will now switch to an
offline installation by default. In this mode, only packages from the
pool will be fetched.

This should allow the installation to proceed when installing from a
private network without external access to the internet.

Signed-off-by: Olivier Gayot <olivier.gayot@canonical.com>
2024-04-12 14:37:02 +02:00
Dan Bungert 13d68ecf89 pre-commit: simplify spelling invocation 2024-04-11 08:10:14 -06:00
Dan Bungert 1dd2388def doc: fix Makefile dependencies 2024-04-11 08:10:14 -06:00
Chris Peterson 979f546f27
Merge pull request #1964 from Chris-Peterson444/pre-commit-spelling
pre-commit: add spelling check
2024-04-10 14:18:25 -07:00
Robert Krátký 797f223705
Merge pull request #1963 from rkratky/review-of-1956
Language and formatting fixes as a follow up to #1956
2024-04-09 13:14:37 +02:00
Robert Krátký ce6dd33e80 Better introduction to autoinstall. 2024-04-09 12:58:51 +02:00
Chris Peterson 5a1b0e35d9 pre-commit: add spelling check
Check for any changed .rst files in the doc/ directory and run
`make spelling` if any changes are detected.

The files directives per hook have to be more restrictive than the
global hook, so this also slightly changes the files match for
the other hooks.
2024-04-05 08:58:54 -07:00
Robert Krátký 219f55258d Language and formatting fixes. 2024-04-05 15:58:08 +02:00
Chris Peterson 26761b4f1a doc: update wordlist 2024-04-04 14:26:12 -07:00
Chris Peterson aed2905db0 doc: consistent top-level autoinstall keyword
Also deletes a note to users about not needing the autoinstall keyword
in non cloud-config delivery methods. We should keep a hint in the reference
that this is available, but generally let's always suggest to use the
top-level autoinstall keyword.
2024-04-04 14:26:08 -07:00
Chris Peterson d812919366 autoinstall: enforce top-level keys
Subiquity currently ignores invalid top-level keys, but this has likely
been a major source of confusion of autoinstall capabilities.

In future versions, the following autoinstall config will throw an
AutoinstallValidationError:

    version: 2
    interactive-sections:
        - identity
    literally-anything: lmao

This patch adds warnings for version 1 and will begin to throw
an AutoinstallValidationError on these instances in version 2 once
it has been enabled.
2024-03-25 19:52:39 -07:00
Olivier Gayot 4ebfcc4fb3 doc: fix documentation of match specs for model and vendor
refs LP: #2056783

Signed-off-by: Olivier Gayot <olivier.gayot@canonical.com>
2024-03-14 17:26:40 +01:00
Dan Bungert 9111298511 quickstart: fix autoinstall indents 2024-03-09 21:51:39 -07:00
Robert Krátký 1b492981b2 Add ubuntu-image reference. 2024-03-07 15:09:47 +01:00
Dan Bungert 2883cad416
Merge pull request #1880 from medicalwei/fixed-reset-partition-size
Accept a fixed partition size for reset partition in autoinstall.yaml
2024-02-12 20:21:10 -07:00
Yao Wei (魏銘廷) 61d748d549 doc: add Reset Partition to `autoinstall-reference.rst` 2024-02-12 16:49:51 +08:00
Chris Peterson 25b65e4e1a doc: use literalinclude for autoinstall-schema
Instead of manually changing the autoinstall-schema reference,
use literalinclude to insert the autoinstall-schema.json file
from the root of the repository.
2024-01-29 09:31:32 -08:00
Robert Krátký 562248af27 Fix Sphinx/rST warnings. 2024-01-10 16:17:57 +01:00
Robert Krátký b2552a3d96 Add search-bar Go button. 2024-01-10 16:17:57 +01:00
Robert Krátký f2504fe859 Update feedback button color. 2024-01-10 16:17:57 +01:00
Robert Krátký 36c115b4f4 Fix code-block copybutton default visibility. 2024-01-10 16:17:57 +01:00
Robert Krátký 0a5bdb9280 Update Sphinx extension names. 2024-01-10 16:17:50 +01:00
Dan Bungert 75a44b122c
Merge pull request #1866 from dbungert/fix-heading-links
doc: fix some link headings
2023-11-06 13:41:17 +02:00
Dan Bungert 929a3df281 doc: update readme for removal of `documentation` 2023-11-02 18:32:56 +02:00
Dan Bungert 7e07c291a0 doc: fix some link headings
The use of spellexception means we have some links that look like:
intro-to-autoinstall.html#autoinstall-by-way-of-cloud-spellexception-config-spellexception

Also these are already wordlisted, so we can fix by just dropping the
inline spellexception.
2023-11-02 18:23:58 +02:00
Robert Krátký 2892082a10 Docs links fixed. 2023-10-27 19:31:01 +02:00
Dan Bungert 454c487242
Merge pull request #1862 from rkratky/FR-5768_review-howtos
Review howtos
2023-10-27 10:16:14 -06:00
Robert Krátký e0593a2dfc Review howto language and formatting. 2023-10-27 18:06:59 +02:00
Robert Krátký 071095183b Architecture naming fix. 2023-10-27 16:11:33 +02:00
Robert Krátký 07f404b404 Review and fixes of doc tutorials. 2023-10-26 17:53:31 +02:00
Dan Bungert 0700be2e6f
Merge pull request #1853 from rkratky/FR-5774_review-references
Review reference docs
2023-10-26 08:13:14 -06:00
Robert Krátký 0dd4ee7bae Language and formatting review of the Reference section. 2023-10-26 11:40:07 +02:00
Robert Krátký e84d2927cf Language and formatting review of Explanations. 2023-10-25 19:58:05 +02:00
Robert Krátký 968ba4e6b4 Redefine the 'command' role in docs. 2023-10-25 14:40:00 +02:00
Dan Bungert 9c6c61691f reference: make bools consistent
pseudo-merge of d604a2156f
2023-10-24 08:43:02 -06:00
Dan Bungert 91e88f3836 reference: fix netplan url 2023-10-24 08:40:10 -06:00
Dan Bungert a9102c3a02 quickstart-s390x: merge wording tweak 2023-10-24 08:40:10 -06:00
Dan Bungert fc55305066 doc: fix 2 spelling errors 2023-10-24 15:37:02 +02:00
Robert Krátký 2496ec6de4 Fix spelling mistakes to pass spellcheck.
Reflect review feedback (to be squashed once PR acked).
2023-10-24 15:36:04 +02:00
Robert Krátký d6be2a9a1d Update the index page. 2023-10-24 15:33:46 +02:00
Dan Bungert d28b09b206 doc: fix 2 spelling errors 2023-10-23 15:22:45 -06:00
Robert Krátký 0fdf1e7b60 Tiny doc fix to trigger docs-check workflow. 2023-10-23 21:56:36 +02:00
Robert Krátký dd24762954 Add docs checks to GH workflows:
* spellcheck
  * linkcheck
  * inclusive-language check
2023-10-23 21:56:36 +02:00
Dan Bungert 4f1b2ccca2
Merge pull request #1847 from rkratky/FR-5738_spellcheck
Fix spelling mistakes to pass spellcheck
2023-10-23 13:46:50 -06:00
Robert Krátký 1c4f2e4e6f Fix spelling mistakes to pass spellcheck.
Reflect review feedback (to be squashed once PR acked).
2023-10-23 21:43:52 +02:00
Dan Bungert 3cd76f11e7
Merge pull request #1850 from rkratky/FR-5543_feedback-button
Update and fix project navigation in docs
2023-10-23 12:02:49 -06:00
Robert Krátký 4bad051494 Update and fix project navigation
* Header titles & links
* Footer links
* Feedback button
2023-10-23 16:28:43 +02:00
Robert Krátký 63a606cd99 Remove the Development section. 2023-10-23 15:19:54 +02:00