Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@sebastian-luna-valero
sebastian-luna-valero committed Aug 28, 2024
1 parent a29a5ff commit f640786
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ Hugo can be installed by following

Hugo (extended) releases can be downloaded from
[the Hugo releases page](https://github.com/gohugoio/hugo/releases).
The recommended version of Hugo to use is
[v0.110.0](https://github.com/gohugoio/hugo/releases/tag/v0.110.0).


To install npm+nodejs please check the
[official instructions](https://www.npmjs.com/get-npm).
Expand All @@ -44,6 +47,14 @@ The dependencies of the docsy theme can be installed as follows:
npm ci
```

A [flox](https://flox.dev/docs/install-flox/) environment is
also available and can be activated with:

```shell
# From the root of the repository clone
flox activate
```

### Building the site

```shell
Expand Down
10 changes: 10 additions & 0 deletions content/en/about/contributing/git/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,16 @@ Hugo can be installed following

Hugo (extended) releases can be downloaded at
[the Hugo releases page](https://github.com/gohugoio/hugo/releases).
The recommended version of Hugo to use is
[v0.110.0](https://github.com/gohugoio/hugo/releases/tag/v0.110.0).

A [flox](https://flox.dev/docs/install-flox/) environment is
also available and can be activated with:

```shell
# From the root of the repository clone
flox activate
```

### Installing pre-commit hooks

Expand Down

1 comment on commit f640786

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@check-spelling-bot Report

🔴 Please review

See the 📜action log or 📝 job summary for details.

Unrecognized words (7)

aarch
flox
gettin
linux
postgres
sourced
venv

To accept these unrecognized words as correct, you could run the following commands

... in a clone of the [email protected]:EGI-Federation/documentation.git repository
on the flox branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/main/apply.pl' |
perl - 'https://github.com/EGI-Federation/documentation/actions/runs/10594578377/attempts/1'
Available 📚 dictionaries could cover words (expected and unrecognized) not in the 📘 dictionary

This includes both expected items (26) from .github/actions/spelling/expect.txt and unrecognized words (7)

Dictionary Entries Covers Uniquely
cspell:npm/dict/npm.txt 302 2 1
cspell:scala/dict/scala.txt 153 2
cspell:filetypes/filetypes.txt 264 2
cspell:node/dict/node.txt 891 2
cspell:cpp/src/compiler-clang-attributes.txt 46 1 1

Consider adding them (in .github/workflows/spelling.yml) for uses: check-spelling/check-spelling@main in its with:

      with:
        extra_dictionaries:
          cspell:npm/dict/npm.txt
          cspell:scala/dict/scala.txt
          cspell:filetypes/filetypes.txt
          cspell:node/dict/node.txt
          cspell:cpp/src/compiler-clang-attributes.txt

To stop checking additional dictionaries, add (in .github/workflows/spelling.yml) for uses: check-spelling/check-spelling@main in its with:

check_extra_dictionaries: ''
Errors (1)

See the 📜action log or 📝 job summary for details.

❌ Errors Count
❌ check-file-path 1

See ❌ Event descriptions for more information.

Please sign in to comment.