Repository for the gRPC website and documentation
Go to file
lucperkins 2f0d53de24 Add link checker
Signed-off-by: lucperkins <lucperkins@gmail.com>
2020-03-06 13:05:47 -08:00
.github/ISSUE_TEMPLATE Create issue template 2019-05-14 10:09:54 -07:00
archetypes Add contents of new site repo 2019-04-22 18:07:24 -07:00
content Add link checker 2020-03-06 13:05:47 -08:00
data Remove public folder from Git 2019-04-22 18:27:11 -07:00
layouts Stop depending on grpc.github.io for the /release uri 2020-02-04 14:49:57 -08:00
static Merge pull request #68 from dcalvin/update-pingcap-usecase 2020-02-21 12:23:43 -08:00
.editorconfig Add editorconfig file 2020-03-04 14:01:59 -08:00
.gitignore Add link checker 2020-03-06 13:05:47 -08:00
.htmltest.external.yml Add link checker 2020-03-06 13:05:47 -08:00
.htmltest.yml Add link checker 2020-03-06 13:05:47 -08:00
CODE-OF-CONDUCT.md Add GOVERNANCE.md, CODE-OF-CONDUCT.md and CONTRIBUTING.md 2019-09-26 15:56:15 -07:00
CONTRIBUTING.md Add GOVERNANCE.md, CODE-OF-CONDUCT.md and CONTRIBUTING.md 2019-09-26 15:56:15 -07:00
GOVERNANCE.md Add GOVERNANCE.md, CODE-OF-CONDUCT.md and CONTRIBUTING.md 2019-09-26 15:56:15 -07:00
LICENSE Add contents of new site repo 2019-04-22 18:07:24 -07:00
Makefile Add link checker 2020-03-06 13:05:47 -08:00
README.md Revamp README and add Docker serving option 2019-04-23 11:03:52 -07:00
config.toml Upgrade to Hugo v0.66.0 (#113) 2020-03-05 11:38:06 -05:00
deploy.sh Add contents of new site repo 2019-04-22 18:07:24 -07:00
netlify.toml Upgrade to Hugo v0.66.0 (#113) 2020-03-05 11:38:06 -05:00

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.