website/DEVELOPMENT.md at main · werf/website · GitHub

___

Development

Install werf.
Install task.

Local development setup

Run jekyll serve with --watch option to test changes in "real time":

Run:
```
task compose:up
```
Check the English version is available on https://localhost, and the Russian version on http://ru.localhost (add ru.localhost record in your /etc/hosts to access the Russian version of the site).

Add configurator content:

Run:
```
task local:gen:configurator
```
Run task clean to cleanup working directory.

Optionally serve documentation content:

Run in werf/werf repository:
```
cd ../werf/werf
task compose:up
```

Cleanup

task compose:down - stop all containers.
task clean - delete all generated content.
docker network delete werfio-dev - delete shared docker network (requires task compose:down in werf/werf repository).

Spell-check management

We use a ./scripts/docs/spelling/wordlist.txt file as the base for creating a custom spell-check dictionary.

Add any new words directly to wordlist.txt in any order.
Run:
```
task site:generate-special-dictionary
```