From 957e26a6f30d40e2bff042d76a327d0a2cfbabae Mon Sep 17 00:00:00 2001 From: Adin Scannell Date: Mon, 18 Nov 2019 13:40:27 -0800 Subject: 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. --- website/README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 website/README.md (limited to 'website/README.md') diff --git a/website/README.md b/website/README.md new file mode 100644 index 000000000..560302c1e --- /dev/null +++ b/website/README.md @@ -0,0 +1,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. -- cgit v1.2.3