elemental-toolkit/docs
Itxaka 0d1833a046
rename master to main (#1587)
Signed-off-by: Itxaka <igarcia@suse.com>
2022-08-09 13:58:54 +02:00
..
archetypes Import docs from external repo (#1297) 2022-05-06 13:43:01 +02:00
assets Import docs from external repo (#1297) 2022-05-06 13:43:01 +02:00
content/en rename master to main (#1587) 2022-08-09 13:58:54 +02:00
layouts rename master to main (#1587) 2022-08-09 13:58:54 +02:00
static Import docs from external repo (#1297) 2022-05-06 13:43:01 +02:00
themes Import docs from external repo (#1297) 2022-05-06 13:43:01 +02:00
.gitignore Import docs from external repo (#1297) 2022-05-06 13:43:01 +02:00
Dockerfile Import docs from external repo (#1297) 2022-05-06 13:43:01 +02:00
README.md Change to new branding (#1466) 2022-06-01 14:49:41 +02:00
config.toml Update cOS references (#1480) 2022-06-06 14:35:48 +02:00
deploy.sh Import docs from external repo (#1297) 2022-05-06 13:43:01 +02:00
docker-compose.yaml Import docs from external repo (#1297) 2022-05-06 13:43:01 +02:00
package-lock.json Import docs from external repo (#1297) 2022-05-06 13:43:01 +02:00
package.json Import docs from external repo (#1297) 2022-05-06 13:43:01 +02:00

README.md

The website content it is deployed automatically in the gh-pages branch by Github Actions, and no manual intevention 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