Commit Graph

21 Commits

Author SHA1 Message Date
Meza 72bce3428f Remove extra white spaces
Signed-off-by: Meza <meza-xyz@proton.me>
2025-04-23 15:47:38 +02:00
Meza 6f84184e89
[Docs] Fix doc typos (#463)
* [Docs] Fix doc typos

Signed-off-by: Meza <meza-xyz@proton.me>

* Fix versioned_docs typos

Signed-off-by: Meza <meza-xyz@proton.me>

---------

Signed-off-by: Meza <meza-xyz@proton.me>
2025-04-22 10:30:37 +02:00
Dustin Groh cdde731593
Update quickstart-cli.md (#459)
Added a section to quickstart-cli to explain how to install the Elemental UI extension via CLI.
2025-02-07 11:42:15 +01:00
Fredrik Lönnegren 1c23cf83cc
Remove mentions of Teal (#316)
Elemental Teal has been the working name for the official elemental OS
built in OBS.

As more and more features are migrated into SLE Micro, Elemental Teal is
being switched out for SLE Micro directly.

This commit serves to make this more obvious in the docs and removes
alot of mentions of Elemental Teal.

Signed-off-by: Fredrik Lönnegren <fredrik.lonnegren@suse.com>
2024-04-08 13:55:56 +00:00
David Cassany cf4f834b17 Restructure the documentation for custom images
Signed-off-by: David Cassany <dcassany@suse.com>
2024-04-03 15:42:11 +02:00
Fredrik Lönnegren ef20e3d9e7
Add how-to guide for raspi disk image (#275)
* Add how-to guide for raspi disk image

The how-to shows how to add a SeedImage that generates a raw disk image
fit for writing to an SD-card and use for a Raspberry Pi machine.

Signed-off-by: Fredrik Lönnegren <fredrik.lonnegren@suse.com>

* Update docs/quickstart-cli.md

Co-authored-by: Francesco Giudici <francesco.giudici@gmail.com>

---------

Signed-off-by: Fredrik Lönnegren <fredrik.lonnegren@suse.com>
Co-authored-by: Francesco Giudici <francesco.giudici@gmail.com>
2024-02-12 14:40:37 +00:00
Nuno do Carmo 0b0bbac1e4
Added canonical links to page headers (#254)
To align with the global Docs SEO optimization, canonical links have been added to all the pages on all the versions.

This will allow users searching for Elemental content to have the latest version displayed on their search results.

Signed-off-by: Nuno do Carmo nuno.carmo@suse.com

Signed-off-by: Nuno do Carmo nuno.carmo@suse.com
2023-12-14 14:20:49 +01:00
Fredrik Lönnegren 741e97d4d2 Use rpi.raw from stable
From https://download.opensuse.org/repositories/isv:/Rancher:/Elemental:/Staging:/containers/rpi.raw
To   https://download.opensuse.org/repositories/isv:/Rancher:/Elemental:/Stable/containers/rpi.raw

Signed-off-by: Fredrik Lönnegren <fredrik.lonnegren@suse.com>
2023-10-23 15:24:11 +02:00
David Cassany Viladomat 15b553d395
Fix some outdated URLs in docs (#216)
Signed-off-by: David Cassany <dcassany@suse.com>
2023-09-18 16:02:52 +02:00
Klaus Kämpf 17d98dc3d7
A customized ISO still needs the registration config added (#194)
* A customized ISO still needs the registration config added

Signed-off-by: Klaus Kämpf <kkaempf@suse.de>

* Update docs/customizing.md

Co-authored-by: Nuno do Carmo <darthnunix@gmail.com>

* Update docs/quickstart-cli.md

Co-authored-by: Nuno do Carmo <darthnunix@gmail.com>

* Update versioned_docs/version-1.2/customizing.md

Co-authored-by: Nuno do Carmo <darthnunix@gmail.com>

* Update versioned_docs/version-1.2/quickstart-cli.md

Co-authored-by: Nuno do Carmo <darthnunix@gmail.com>

---------

Signed-off-by: Klaus Kämpf <kkaempf@suse.de>
Co-authored-by: Nuno do Carmo <darthnunix@gmail.com>
2023-08-09 07:17:28 +00:00
Francesco Giudici 013000d4f4
v1.1.5 operator chart released: update stable (#156)
* v1.1.5 released: re-generate Stable from Next

* stable: change the chart links pointing to staging to stable

* fix reference to 'fire-nodes'

---------

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
2023-06-22 17:33:07 +02:00
Francesco Giudici 4d9b579397
quickstart improvement, second round (#153)
* quickstart: improve it, second round

* Update docs/partials/_elemental-operator-install.md

* Update docs/quickstart-cli.md

* Update docs/quickstart-cli.md

---------

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
Co-authored-by: Klaus Kämpf <kkaempf@suse.de>
2023-06-22 15:27:24 +02:00
Francesco Giudici 7cce39b211
Rework the quickstart cli guide (#147)
* Syntax: small fixes

* Update quickstart with the staging splitted chart

* Rework quickstart and examples

* drop extra space

* change 'location:europe' with 'element:fire' all throughout the docs

* Update versioned_docs/version-Stable/quickstart-cli.md

* Update docs/partials/_elemental-operator-install.md

* Update docs/quickstart-cli.md

* quickstart: drop unneded "automatically"

* Fix typo

* [stable] quickstart: sync from next

---------

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
Co-authored-by: Julien ADAMEK <julien.adamek@suse.com>
Co-authored-by: Klaus Kämpf <kkaempf@suse.de>
2023-06-21 15:03:42 +02:00
Francesco Giudici e800a7cb3c Sync the versioned stable to current docs
Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
2023-04-27 11:22:35 +02:00
e-minguez d8b295c389 Added an example on mounting the rpi.raw image 2023-04-26 17:20:29 +02:00
Julien Adamek 7e84837e2e Improve SeedImage & MachineRegistration docs 2023-04-24 17:38:39 +02:00
Julien Adamek 4465943a49 Remove useless character in quickstart 2023-04-24 09:00:58 +02:00
Klaus Kämpf 5163b85cbb Pull rpi.raw from the Stable branch
Signed-off-by: Klaus Kämpf <kkaempf@suse.de>
2023-04-20 18:49:46 +02:00
Julien Adamek bf324cf315 Document seedImage in UI quickstart
* How to build and download seedImage ISO
2023-04-18 17:19:51 +02:00
Fredrik Lönnegren 15ba929373
Adding documentation for seedimage (#65)
* Adding documentation for seedimage

Replace the manual ISO creation in quickstart with seed-image resource.

Add page for seedimage reference.

Signed-off-by: Fredrik Lönnegren <fredrik.lonnegren@suse.com>

* Add wait command for seedimage in quickstart

Signed-off-by: Fredrik Lönnegren <fredrik.lonnegren@suse.com>

* Fix markdown link in quickstart

Signed-off-by: Fredrik Lönnegren <fredrik.lonnegren@suse.com>

---------

Signed-off-by: Fredrik Lönnegren <fredrik.lonnegren@suse.com>
2023-03-30 14:04:29 +02:00
Nuno do Carmo e9221c37d0
New quickstart UI and menu (#69)
* New quickstart UI and browsing

This PR changes the Quickstart menu and adds a new Quickstart UI page.

The menu shows the two options to install and use Elemental:

* First option is through Rancher Manager with the Elemental plugin
* Second option is with the CLI only

To avoid duplicates of common parts between the two UIs, the `partial` feature from Docusaurus is used.

This allows to write one portion of documentation into one page only, and import the page into both Quickstart pages.

Finally, the Overview has also been updated with the description of what's the Elemental stack. This is best fit there, instead of the Quickstart.

Signed-off-by: Nuno do Carmo <nuno.carmo@suse.com>

* Image bad trimming fixed

Signed-off-by: Nuno do Carmo <nuno.carmo@suse.com>

* Added the Endpoint Registration

The `Endpoint Registration` is the last configuration part from a configuration point of view.

Remaining part for creating the ISO and booting a first instance will be added in a different PR.

Signed-off-by: Nuno do Carmo <nuno.carmo@suse.com>

* Applied suggestion

Co-authored-by: Francesco Giudici <francesco.giudici@gmail.com>

---------

Signed-off-by: Nuno do Carmo <nuno.carmo@suse.com>
Co-authored-by: Francesco Giudici <francesco.giudici@gmail.com>
2023-03-29 16:54:59 +02:00