summaryrefslogtreecommitdiffhomepage
path: root/website/README.md
blob: 560302c1e3014e9417b0fe5b76ce1a3adf5e33c9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# gVisor Website

This repository holds the content for the gVisor website, including
documentation.

## Requirements

Building the website requires Docker.

## Contributing to Documentation

### Using Github

You can use the "Edit this page" link on any documentation page to edit the page
content directly via GitHub and submit a pull request. This should generally be
done for relatively small changes.

### Using Git

You can submit pull requests by making changes in a Git branch. See more
information on GitHub pull requests
[here](https://help.github.com/en/articles/about-pull-requests).

Documentation is located in the [content/docs/](content/docs/) directory.

## Building

You can build the site locally by running:

```
make build
```

Incremental changes can be generated using:


```
make update
```

And the site can be served locally using:

```
make server
```

Access the site at `http://localhost:8080`.

The above will build all parts of the site, including the serving components.