600f27bf5c
Signed-off-by: lucperkins <lucperkins@gmail.com> |
||
|---|---|---|
| .github/ISSUE_TEMPLATE | ||
| archetypes | ||
| assets/sass | ||
| content | ||
| data | ||
| layouts | ||
| node_modules | ||
| static | ||
| .editorconfig | ||
| .gitignore | ||
| .htmltest.external.yml | ||
| .htmltest.yml | ||
| CODE-OF-CONDUCT.md | ||
| CONTRIBUTING.md | ||
| GOVERNANCE.md | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| config.toml | ||
| deploy.sh | ||
| netlify.toml | ||
| package.json | ||
| 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.
Running the site locally
To run the site locally, you need to install Hugo. Once Hugo is installed:
make serve
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 re-built and re-deployed. This process does not require manual management.
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.