Skip to content

Commit 802e8c1

Browse files
committed
doc(docs): add installation pointer for rvm and add that no one should ever commit files from the _site ditrectory
1 parent 4c0ba49 commit 802e8c1

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

‎docs/contributing/documentation.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,9 @@ Contributing to this documentation is extremely important as many users will ref
3636
If you plan to contribute to the docs, we recommend that you locally install `jekyll` so you can test your changes locally.
3737
We also recommend, that you install `jekyll` into a a ruby enviroment so it does not interfere with any other installations you might have.
3838

39+
We recommend that you install `rbenv` and `rvm` to manage your ruby installation.
3940
`rbenv` is a tool that mangages different ruby versions, similar to what `conda` does for `python`.
40-
Please [install rbenv](https://github.com/rbenv/rbenv?tab=readme-ov-file#installation) following their instructions.
41+
Please [install rbenv](https://github.com/rbenv/rbenv?tab=readme-ov-file#installation) following their instructions, and the same for [install rvm](https://github.com/rvm/rvm?tab=readme-ov-file#installing-rvm).
4142
We recommend that you install a ruby version `>=3.0`.
4243
After having installed an isolated ruby version, you have to install the dependencies to build the docs locally.
4344
The `docs` directory has a `Gemfile` which specifies the dependencies.
@@ -53,6 +54,7 @@ To do this, simply to the following.
5354
bundle exec jekyll server --livereload --verbose
5455
```
5556
In the browser of your choice, you can then go to `http://127.0.0.1:4000/` and you will be served the documentation, which is re-build and re-loaded after any change to the `docs`.
57+
``jekyll`` will create a ``_site`` directory where it saves the created files, please **never commit any files from the \_site directory**!
5658

5759
## Open Issues
5860
If you're interested in existing issues, you can

0 commit comments

Comments
 (0)