blob: c16221350a6ae9198dd3351245104b692c3c2e7a (
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
# gVisor Website
This repository holds the content for the gVisor website. It uses
[hugo](https://gohugo.io/) to generate the website and
[Docsy](https://github.com/google/docsy) as the theme.
## Using Github
The easiest way to contribute to the documentation is to 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 changes to
a single page.
## 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.
Documentation is written in markdown with hugo extensions. Please read more
about [content management](https://gohugo.io/categories/content-management) in
the hugo documentation.
### Requirements
Building the website requires [Docker](https://www.docker.com/). Please
[install](https://docs.docker.com/install/) it before building.
### Building
If you want to simply build the website, you can do that using `make`. This
will output the App Engine application code, configuration, and html and CSS
into the `public/` directory.
```
make
```
### Testing
You can use the hugo web server for testing documentation or style changes.
This will start a webserver that will rebuild the site when you make content
changes:
```
make devserver
```
Access the site at http://localhost:8080
If you need to test all functionality including redirects you can start the App
Engine app locally. However, you will need to restart the app when making
content changes:
```
make server
```
## Updating Styles
If you want to update style on the website you can do this by updating
templates or CSS for the website. Check out the [Hugo
documentation](https://gohugo.io/documentation/) for info on hugo templating.
Check out the [Docsy documentation](https://www.docsy.dev/docs/) for info on
the Docsy theme.
### Custom templates, partials, and shortcodes
Custom templates, including partials and shortcodes, should go under the
[layouts/](layouts) directory.
## Custom CSS
Custom CSS styles should go into the
[_styles_project.scss](assets/scss/_styles_project.scss) file.
If you need to override or create variables used in scss styles, update the
[_variables_project.scss](assets/scss/_variables_project.scss) file.
## Troubleshooting
#### I get errors when building the website.
If you get the following errors you should check that you have the "extended"
version of Hugo. This is the version of hugo named "hugo\_extended" on the
[releases page](https://github.com/gohugoio/hugo/releases).
|
