Initial commit
@@ -0,0 +1,5 @@
|
||||
# Explicitly add .git so that hugo has git commit info
|
||||
!.git
|
||||
public/
|
||||
resources/
|
||||
node_modules/
|
||||
@@ -0,0 +1,4 @@
|
||||
public/
|
||||
resources/
|
||||
node_modules/
|
||||
upstream/
|
||||
@@ -0,0 +1,28 @@
|
||||
# How to Contribute
|
||||
|
||||
We'd love to accept your patches and contributions to this project. There are
|
||||
just a few small guidelines you need to follow.
|
||||
|
||||
## Contributor License Agreement
|
||||
|
||||
Contributions to this project must be accompanied by a Contributor License
|
||||
Agreement. You (or your employer) retain the copyright to your contribution;
|
||||
this simply gives us permission to use and redistribute your contributions as
|
||||
part of the project. Head over to <https://cla.developers.google.com/> to see
|
||||
your current agreements on file or to sign a new one.
|
||||
|
||||
You generally only need to submit a CLA once, so if you've already submitted one
|
||||
(even if it was for a different project), you probably don't need to do it
|
||||
again.
|
||||
|
||||
## Code reviews
|
||||
|
||||
All submissions, including submissions by project members, require review. We
|
||||
use GitHub pull requests for this purpose. Consult
|
||||
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
|
||||
information on using pull requests.
|
||||
|
||||
## Community Guidelines
|
||||
|
||||
This project follows
|
||||
[Google's Open Source Community Guidelines](https://opensource.google.com/conduct/).
|
||||
@@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
@@ -0,0 +1,77 @@
|
||||
HUGO := hugo
|
||||
HUGO_VERSION := 0.53
|
||||
HTMLPROOFER_VERSION := 3.10.2
|
||||
NPM := npm
|
||||
GCLOUD := gcloud
|
||||
GCP_PROJECT := gvisor-website
|
||||
|
||||
# Source Go files. example: main.go foo/bar.go
|
||||
GO_SOURCE = $(shell find cmd/gvisor-website -type f -name "*.go" | sed 's/ /\\ /g')
|
||||
# Target Go files. example: public/main.go public/foo/bar.go
|
||||
GO_TARGET = $(shell cd cmd/gvisor-website && find . -type f -name "*.go" | sed 's/ /\\ /g' | sed 's/^.\//public\//')
|
||||
|
||||
default: website
|
||||
.PHONY: default
|
||||
|
||||
website: all-upstream public/app.yaml $(GO_TARGET) public/static
|
||||
.PHONY: website
|
||||
|
||||
public:
|
||||
mkdir -p public
|
||||
public/app.yaml: public
|
||||
cp -vr cmd/gvisor-website/app.yaml public/
|
||||
|
||||
|
||||
|
||||
# Load repositories.
|
||||
upstream:
|
||||
mkdir -p upstream
|
||||
upstream-%: upstream
|
||||
if [ -d upstream/$* ]; then (cd upstream/$* && git pull --rebase); else git clone https://gvisor.googlesource.com/$*/ upstream/$*; fi
|
||||
all-upstream: upstream-gvisor upstream-community
|
||||
# All repositories are listed here: force updates.
|
||||
.PHONY: all-upstream upstream-%
|
||||
|
||||
# This target regenerates the sigs directory; this is not PHONY.
|
||||
content/docs/community/sigs: upstream/community $(wildcard upstream/community/sigs/*)
|
||||
rm -rf content/docs/community/sigs && mkdir -p content/docs/community/sigs
|
||||
for file in $(shell cd upstream/community/sigs && ls -1 *.md | cut -d'.' -f1 | grep -v TEMPLATE); do \
|
||||
title=$$(cat upstream/community/sigs/$$file.md | grep -E '^# ' | cut -d' ' -f2-); \
|
||||
echo -e "+++\ntitle = \"$$title\"\n+++\n" > content/docs/community/sigs/$$file.md; \
|
||||
cat upstream/community/sigs/$$file.md |grep -v -E '^# ' >> content/docs/community/sigs/$$file.md; \
|
||||
done
|
||||
|
||||
$(GO_TARGET): public $(GO_SOURCE)
|
||||
cd cmd/gvisor-website && find . -name "*.go" -exec cp --parents \{\} ../../public \;
|
||||
|
||||
deploy: public/app.yaml
|
||||
cd public && $(GCLOUD) app deploy
|
||||
.PHONY: deploy
|
||||
|
||||
public/static: node_modules config.toml $(shell find archetypes assets content themes -type f | sed 's/ /\\ /g')
|
||||
$(HUGO)
|
||||
|
||||
server: all-upstream
|
||||
$(HUGO) server -FD --port 8080
|
||||
|
||||
node_modules: package.json package-lock.json
|
||||
# Use npm ci because npm install will update the package-lock.json.
|
||||
# See: https://github.com/npm/npm/issues/18286
|
||||
$(NPM) ci
|
||||
|
||||
cloud-build:
|
||||
gcloud builds submit --config cloudbuild/cloudbuild.yaml .
|
||||
|
||||
hugo-docker-image:
|
||||
docker build --build-arg HUGO_VERSION=$(HUGO_VERSION) -t gcr.io/gvisor-website/hugo:$(HUGO_VERSION) cloudbuild/hugo/
|
||||
docker push gcr.io/gvisor-website/hugo:$(HUGO_VERSION)
|
||||
.PHONY: hugo-docker-image
|
||||
|
||||
htmlproofer-docker-image:
|
||||
docker build --build-arg HTMLPROOFER_VERSION=$(HTMLPROOFER_VERSION) -t gcr.io/gvisor-website/html-proofer:$(HTMLPROOFER_VERSION) cloudbuild/html-proofer/
|
||||
docker push gcr.io/gvisor-website/html-proofer:$(HTMLPROOFER_VERSION)
|
||||
.PHONY: htmlproofer-docker-image
|
||||
|
||||
clean:
|
||||
rm -rf public/ resources/ node_modules/ upstream/
|
||||
.PHONY: clean
|
||||
@@ -0,0 +1,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.
|
||||
|
||||
## Requirements
|
||||
|
||||
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.
|
||||
|
||||
- Node.js >= 10.15.0 LTS
|
||||
- hugo extended >= v0.53
|
||||
|
||||
## Building
|
||||
|
||||
Build the website using `make`:
|
||||
|
||||
```
|
||||
make
|
||||
```
|
||||
|
||||
This will output the App Engine application code, configuration, and html and
|
||||
CSS into the `public/` directory.
|
||||
|
||||
## Testing
|
||||
|
||||
You can use the hugo web server for testing. This will start a webserver that
|
||||
will rebuild the site when you make content changes:
|
||||
|
||||
```
|
||||
make server
|
||||
```
|
||||
|
||||
Access the site at http://localhost:8080
|
||||
|
||||
## Deploy
|
||||
|
||||
Deploying the webiste to App Engine requires gcloud. First create a configuration:
|
||||
|
||||
```
|
||||
{
|
||||
gcloud config configurations create gvisor-website
|
||||
gcloud config set project gvisor-website
|
||||
}
|
||||
```
|
||||
|
||||
Deploy the application:
|
||||
|
||||
```
|
||||
make deploy
|
||||
```
|
||||
|
||||
## Editing documentation
|
||||
|
||||
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.
|
||||
|
||||
## Submit a Build
|
||||
|
||||
Normally a build is triggered when you push to the gvisor-website repository.
|
||||
However, you can submit a build to Cloud Build manually.
|
||||
|
||||
As one-time setup, enable the App Engine Admin API, and set IAM roles for the [Cloud Build service
|
||||
account](https://cloud.google.com/cloud-build/docs/securing-builds/set-service-account-permissions).
|
||||
|
||||
```
|
||||
{
|
||||
PROJECT_NUMBER=$(gcloud projects list --filter=gvisor-website --format="value(projectNumber)")
|
||||
gcloud services enable appengine.googleapis.com
|
||||
gcloud projects add-iam-policy-binding gvisor-website \
|
||||
--member=serviceAccount:${PROJECT_NUMBER}@cloudbuild.gserviceaccount.com \
|
||||
--role='roles/appengine.deployer'
|
||||
gcloud projects add-iam-policy-binding gvisor-website \
|
||||
--member=serviceAccount:${PROJECT_NUMBER}@cloudbuild.gserviceaccount.com \
|
||||
--role='roles/appengine.serviceAdmin'
|
||||
}
|
||||
```
|
||||
|
||||
Submit the build.
|
||||
|
||||
```
|
||||
make cloud-build
|
||||
```
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
title: "{{ replace .Name "-" " " | title }}"
|
||||
date: {{ .Date }}
|
||||
draft: true
|
||||
---
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
../logos/logo_solo_on_dark.svg
|
||||
@@ -0,0 +1,10 @@
|
||||
#!/usr/bin/make -f
|
||||
|
||||
srcs := $(wildcard *.svg)
|
||||
dsts := $(patsubst %.svg,%.png,$(srcs))
|
||||
|
||||
all: $(dsts)
|
||||
.PHONY: all
|
||||
|
||||
%.png: %.svg
|
||||
@inkscape -z -e $@ $<
|
||||
@@ -0,0 +1,10 @@
|
||||
# Logos
|
||||
|
||||
This directory contains logo assets.
|
||||
|
||||
The colors used are:
|
||||
|
||||
* Background (blue): #262262
|
||||
* Highlight (yellow): #FBB03B
|
||||
|
||||
Use `make` to generate sized PNGs from SVGs.
|
||||
|
After Width: | Height: | Size: 10 KiB |
|
After Width: | Height: | Size: 5.7 KiB |
|
After Width: | Height: | Size: 58 KiB |
|
After Width: | Height: | Size: 5.8 KiB |
|
After Width: | Height: | Size: 701 B |
|
After Width: | Height: | Size: 8.2 KiB |
|
After Width: | Height: | Size: 5.7 KiB |
|
After Width: | Height: | Size: 78 KiB |
|
After Width: | Height: | Size: 8.4 KiB |
|
After Width: | Height: | Size: 900 B |