mirror of
https://github.com/netbirdio/gvisor.git
synced 2026-05-22 17:12:49 -07:00
Update readme with new docs.
- Rearrange the docs into sections on using Github or Git locally. - Remove the troubleshooting FAQ since we build using Docker.
This commit is contained in:
@@ -4,24 +4,14 @@ 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.
|
||||
|
||||
## Requirements
|
||||
## Using Github
|
||||
|
||||
Building the website requires the extended version of
|
||||
[hugo](https://gohugo.io/) and [node.js](https://nodejs.org/) in order to
|
||||
generate CSS files. Please install them before building.
|
||||
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.
|
||||
|
||||
- Node.js >= 10.15.0 LTS
|
||||
- hugo extended >= v0.53
|
||||
|
||||
## 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
|
||||
## Using Git
|
||||
|
||||
You can submit pull requests by making changes in a Git branch. See more
|
||||
information on GitHub pull requests
|
||||
@@ -32,47 +22,37 @@ Documentation is written in markdown with hugo extensions. Please read more
|
||||
about [content management](https://gohugo.io/categories/content-management) in
|
||||
the hugo documentation.
|
||||
|
||||
You can use the hugo web server for testing. This will start a webserver that
|
||||
will rebuild the site when you make content changes:
|
||||
### Requirements
|
||||
|
||||
```
|
||||
make server
|
||||
```
|
||||
Building the website requires [Docker](https://www.docker.com/). Please
|
||||
[install](https://docs.docker.com/install/) it before building.
|
||||
|
||||
Access the site at http://localhost:8080
|
||||
### Building
|
||||
|
||||
## Building
|
||||
|
||||
If you are making changes to App Engine config or application code, you can
|
||||
build the website using `make`. This will output the App Engine application
|
||||
code, configuration, and html and CSS into the `public/` directory.
|
||||
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
|
||||
```
|
||||
|
||||
If you have Go installed you can run a local version of the website via the
|
||||
`public/` directory.
|
||||
### 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:
|
||||
|
||||
```
|
||||
cd public/
|
||||
go run main.go
|
||||
make devserver
|
||||
```
|
||||
|
||||
Access the site at http://localhost:8080
|
||||
|
||||
## 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).
|
||||
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:
|
||||
|
||||
```
|
||||
ERROR 2019/04/03 11:25:58 Failed to add template "partials/navbar.html" in path "/home/me/gvisor-website/layouts/partials/navbar.html": template: partials/navbar.html:5: function "resources" not defined
|
||||
ERROR 2019/04/03 11:25:58 partials/navbar.html : template: partials/navbar.html:5: function "resources" not defined
|
||||
ERROR 2019/04/03 11:25:58 Unable to locate template for shortcode "readfile" in page "docs/user_guide/docker.md"
|
||||
ERROR 2019/04/03 11:25:58 Unable to locate template for shortcode "readfile" in page "docs/user_guide/oci.md"
|
||||
ERROR 2019/04/03 11:25:58 Unable to locate template for shortcode "blocks" in page "_index.html"
|
||||
make server
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user