aae9235be6
* Change wording on gRPC origin Signed-off-by: lucperkins <lucperkins@gmail.com> * Templatize Why gRPC section Signed-off-by: lucperkins <lucperkins@gmail.com> * s/implement/generate |
||
|---|---|---|
| .github/ISSUE_TEMPLATE | ||
| archetypes | ||
| assets/sass | ||
| content | ||
| data | ||
| includes | ||
| layouts | ||
| static | ||
| themes | ||
| .browerslistrc | ||
| .editorconfig | ||
| .gitignore | ||
| .gitmodules | ||
| .htmltest.external.yml | ||
| .htmltest.yml | ||
| CODE-OF-CONDUCT.md | ||
| CONTRIBUTING.md | ||
| GOVERNANCE.md | ||
| LICENSE | ||
| LICENSE-DOCS | ||
| MAINTAINERS.md | ||
| Makefile | ||
| README.md | ||
| check_hugo.sh | ||
| config.yaml | ||
| deploy.sh | ||
| netlify.toml | ||
| package.json | ||
| postcss.config.js | ||
| yarn.lock | ||
README.md
The gRPC website and documentation
This repository houses the assets used to build and deploy the gRPC website, available at https://grpc.io. The site is built using the Hugo static site generator. Check out the Hugo Quick Start for a quick intro.
Prerequisites
- Hugo, extended version
- nvm, the Node Version Manager
Serving the site locally
First install NPM packages:
$ npm install
To build and locally serve this site, you can use any one of the following commands:
-
Build and serve using Hugo, via
make:$ make serve -
Build and serve using Netlify dev, which allows you to exercise features such as site redirects:
$ npx netlify dev -
Alternatively, you can run the site using a Docker container:
$ make docker-serve
Publishing the site
The gRPC website is automatically published by Netlify. Any time changes
are pushed to the master branch, the site is rebuilt and redeployed.
Site content
All of the Markdown content used to build the site's documentation, blog, etc. is in the content directory.
Checking links
You can check the site's internal links by running this command:
$ make check-internal-links
This deletes the generated public directory, builds the "production" version
of the site, and verifies that internal links are valid. Please note that
internal links prefixed with /grpc do not work in your local environment
(there are redirects applied by Netlify). Any errors
returned from /grpc links are false negatives that you can ignore.