Skip to content

Commit c0deb83

Browse files
authored
doc: Add website deployment documentation (#3889)
1 parent 9571a47 commit c0deb83

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

doc/_release/WEBSITE.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Spoon website documentation for maintainers
2+
3+
This document contains everything you need to know about the Spoon website in order to maintain and update it. The website is currently hosted at https://spoon.gforge.inria.fr/.
4+
5+
## Building the website locally
6+
7+
To build the website locally, you only need to have Jekyll installed, which is a [Ruby gem](https://en.wikipedia.org/wiki/RubyGems). Typically, you would install this with the `gem` command, assuming that you have Ruby (2.4+ required) installed.
8+
9+
```bash
10+
$ gem install jekyll
11+
```
12+
13+
Pay attention to the output of `gem install`, it provides useful information such as warning when the installed `jekyll` binary is not on your `PATH`. When `jekyll` is installed, you can serve the website by going to the `doc` directory and executing `jekyll serve`.
14+
15+
```bash
16+
$ jekyll serve
17+
Configuration file: /path/to/spoon/doc/_config.yml
18+
Source: /path/to/spoon/doc
19+
Destination: /path/to/spoon/doc/_site
20+
Incremental build: disabled. Enable with --incremental
21+
Generating...
22+
done in 0.102 seconds.
23+
Auto-regeneration: enabled for '/path/to/spoon/doc'
24+
Server address: http://127.0.0.1:4000/
25+
Server running... press ctrl-c to stop.
26+
```
27+
28+
The website will automatically regenerate as you make changes in the source files.
29+
30+
> **Note:** You may also need to separately install the gem `webrick` if there is a crash when running `jekyll serve`.
31+
32+
> **Note:** To get the proper index page, copy the root README to `doc/doc_homepage.md`.
33+
34+
## Deploying the website
35+
36+
The website is automatically deployed to the [SpoonLabs GitHub Pages repository](https://github.com/spoonlabs/spoonlabs.github.io). The deployment is handled by a GitHub Actions workflow in said repository, [see the README](https://github.com/SpoonLabs/SpoonLabs.github.io/blob/main/README.md) for details.

0 commit comments

Comments
 (0)