gvisor/website
Adin Scannell 957e26a6f3 Move website to a simpler jekyll-based template
This will allow us to merge the site into the main repository.

This merge allows the documentation to be kept up-to-date and
synchronized with the main project. Builds will be triggered on any
update, removing the need for the cron-based reploy.
2020-04-21 12:00:59 -07:00
..
cmd Move website to a simpler jekyll-based template 2020-04-21 12:00:59 -07:00
content Move website to a simpler jekyll-based template 2020-04-21 12:00:59 -07:00
static Move website to a simpler jekyll-based template 2020-04-21 12:00:59 -07:00
.gitignore Move website to a simpler jekyll-based template 2020-04-21 12:00:59 -07:00
Dockerfile Move website to a simpler jekyll-based template 2020-04-21 12:00:59 -07:00
Makefile Move website to a simpler jekyll-based template 2020-04-21 12:00:59 -07:00
README.md Move website to a simpler jekyll-based template 2020-04-21 12:00:59 -07:00
app.yaml Move website to a simpler jekyll-based template 2020-04-21 12:00:59 -07:00
cloudbuild.yaml Move website to a simpler jekyll-based template 2020-04-21 12:00:59 -07:00
cron.yaml Move website to a simpler jekyll-based template 2020-04-21 12:00:59 -07:00
go.mod Move website to a simpler jekyll-based template 2020-04-21 12:00:59 -07:00
go.sum Move website to a simpler jekyll-based template 2020-04-21 12:00:59 -07:00
package-lock.json Move website to a simpler jekyll-based template 2020-04-21 12:00:59 -07:00
package.json Move website to a simpler jekyll-based template 2020-04-21 12:00:59 -07:00

README.md

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.

Documentation is located in the 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.