elemental-toolkit/docs
David Cassany Viladomat c05f5d4913
bump elemental-toolkit to v2 (#1969)
* bump elemental-toolkit to v2

Signed-off-by: David Cassany <dcassany@suse.com>

* Move pkg/types/v2 to simply pkg/types

This commit leaves the code with a single set of types
and in refers to it as the types packge instead of
v1 or v2.

For the time being we do not foresee managing more
than one single major version of type within the
same code.

Signed-off-by: David Cassany <dcassany@suse.com>

* Stop referring to mocks package as v2mock in favor of simply 'mocks'

Signed-off-by: David Cassany <dcassany@suse.com>

* Fix leftovers after rebase

Signed-off-by: David Cassany <dcassany@suse.com>

---------

Signed-off-by: David Cassany <dcassany@suse.com>
2024-03-08 09:14:56 +01:00
..
archetypes
assets
content/en fix broken link (#1985) 2024-03-05 09:17:12 +01:00
layouts rename master to main (#1587) 2022-08-09 13:58:54 +02:00
static
themes Update docsy to latest version (#1786) 2023-06-05 13:23:35 +02:00
.gitignore
README.md docs: Small changes (#1645) 2022-11-17 12:58:55 +01:00
config.toml Update docsy to latest version (#1786) 2023-06-05 13:23:35 +02:00
elemental.md [auto] Update cmd docs (#472) 2023-04-11 14:06:01 +02:00
elemental_build-iso.md [auto] Update cmd docs (#479) 2023-04-26 12:43:14 +02:00
elemental_cloud-init.md [auto] Update cmd docs (#383) 2022-12-22 10:18:41 +01:00
elemental_convert-disk.md [auto] Update cmd docs (#383) 2022-12-22 10:18:41 +01:00
elemental_exit-codes.md Regenerate docs 2024-02-22 12:42:29 +01:00
elemental_install.md Regenerate docs 2024-02-22 12:42:29 +01:00
elemental_new.md [auto] Update cmd docs (#383) 2022-12-22 10:18:41 +01:00
elemental_pull-image.md [auto] Update cmd docs (#479) 2023-04-26 12:43:14 +02:00
elemental_reset.md Regenerate docs 2024-02-22 12:42:29 +01:00
elemental_run-stage.md [auto] Update cmd docs (#383) 2022-12-22 10:18:41 +01:00
elemental_upgrade.md Regenerate docs 2024-02-22 12:42:29 +01:00
elemental_version.md [auto] Update cmd docs (#383) 2022-12-22 10:18:41 +01:00
generate_docs.go bump elemental-toolkit to v2 (#1969) 2024-03-08 09:14:56 +01:00
package-lock.json Fix docs 2023-06-05 13:49:01 +02:00
package.json Fix docs 2023-06-05 13:49:01 +02:00

README.md

The website content it is deployed automatically in the gh-pages branch by Github Actions, and no manual intervention is needed.

Test your changes

After cloning the repo (with submodules), just run make serve to test the website locally.

$> git clone --recurse-submodule https://github.com/rancher/elemental-toolkit
$> cd elemental-toolkit
$> make serve

Or just sync the submodules:

$> git submodule update --init --recursive --depth 1

To run the website locally in other platforms, e.g. MacOS:

$> HUGO_PLATFORM=macOS-64bit make serve