Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Flox environment #668

Merged
merged 13 commits into from
Aug 29, 2024
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@ Source files used to build [EGI documentation](https://docs.egi.eu).
- postcss-cli
- autoprofixer

## Installing dependencies, building and testing locally
These dependencies can be either installed manually or
reusing a flox environment. Please see the steps below.

### Installing dependencies manually

Hugo can be installed by following
[the official documentation](https://gohugo.io/getting-started/installing).
Expand Down Expand Up @@ -59,6 +62,8 @@ you can reuse the provided environment with:
```shell
# From the root of the repository clone
flox activate
# Then install docsy dependencies with
npm ci
```

### Building the site
Expand Down
9 changes: 7 additions & 2 deletions content/en/about/contributing/git/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,10 @@ can be used as a reference for building instructions.
- postcss-cli
- autoprofixer

### Installing dependencies
These dependencies can be either installed manually or
reusing a flox environment. Please see the steps below.

#### Installing dependencies manually

To install npm+Node.js please check the
[official instructions](https://www.npmjs.com/get-npm).
Expand All @@ -157,7 +160,7 @@ Hugo (extended) releases can be downloaded at
The recommended version for Hugo is specified under the GitHub Action in
[.github/workflows/hugo_version.txt](https://github.com/EGI-Federation/documentation/blob/main/.github/workflows/hugo_version.txt).

#### Reuse the flox environment (optional)
#### Reuse the flox environment

[Flox](https://flox.dev/) is a virtual environment and package manager
all in one. We provide a flox environment in our GitHub repository
Expand All @@ -170,6 +173,8 @@ you can reuse the provided environment with:
```shell
# From the root of the repository clone
$ flox activate
# Then install docsy dependencies with
npm ci
gwarf marked this conversation as resolved.
Show resolved Hide resolved
```

### Installing pre-commit hooks
Expand Down
Loading