summaryrefslogtreecommitdiffhomepage
path: root/website/README.md
diff options
context:
space:
mode:
authorAdin Scannell <ascannell@google.com>2020-05-06 14:15:15 -0700
committerAdin Scannell <ascannell@google.com>2020-05-06 14:15:15 -0700
commite8bb5832b32d865e8dc257b01bebfd7dafeaaccf (patch)
treec5ea0518f0aa7ac1fcc999119030e931500d864c /website/README.md
parent279f1eb7abb28966ef633fa61418bffad4a716b0 (diff)
parent957e26a6f30d40e2bff042d76a327d0a2cfbabae (diff)
Merge gvisor-website
Diffstat (limited to 'website/README.md')
-rw-r--r--website/README.md49
1 files changed, 49 insertions, 0 deletions
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.