grpc
/
grpc.io
mirror of https://github.com/grpc/grpc.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Repository for the gRPC website and documentation
288 Commits 1 Branch 0 Tags 212 MiB
HTML 53%
SCSS 36.4%
Shell 8.7%
Makefile 1.9%
Go to file
Luc Perkins cf9efbe10d
Add anchor bookmarks (#154) 
* Add header links

Signed-off-by: lucperkins <lucperkins@gmail.com>

* CSS partial housekeeping

Signed-off-by: lucperkins <lucperkins@gmail.com>

* Add scroll offset

Signed-off-by: lucperkins <lucperkins@gmail.com>
 		2020-03-20 08:15:03 -04:00
.github/ISSUE_TEMPLATE Create issue template 2019-05-14 10:09:54 -07:00
archetypes More blog post cleanup 2020-03-10 11:36:12 -07:00
assets/sass Add anchor bookmarks (#154) 2020-03-20 08:15:03 -04:00
content Fixes stutter on error model documentation (#155) 2020-03-20 08:11:26 -04:00
data Kotlin/JVM platforms 2020-03-17 13:57:33 -04:00
layouts Add anchor bookmarks (#154) 2020-03-20 08:15:03 -04:00
node_modules Add node_modules to Git 2020-03-05 13:03:22 -08:00
static Add CNCF section to main page 2020-03-09 12:41:37 -07:00
.editorconfig Convert contributing guide to Markdown 2020-03-09 16:01:17 -07: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 Ensure Hugo is properly installed 2020-03-18 13:23:50 -07:00
README.md README: Hugo extended version is needed 2020-03-18 16:22:51 -04:00
check_hugo.sh Ensure Hugo is properly installed 2020-03-18 13:23:50 -07:00
config.toml Update grpc-java release tag to v1.28.0 (#128) 2020-03-11 20:56:59 -04:00
deploy.sh Add contents of new site repo 2019-04-22 18:07:24 -07:00
netlify.toml Upgrade to Hugo 0.67.0 (#126) 2020-03-10 16:47:35 -04:00
package.json Set up Sass pipeline 2020-03-05 13:03:07 -08:00
yarn.lock Set up Sass pipeline 2020-03-05 13:03:07 -08: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.

Serving the site locally

To build and locally serve this site, you need to install Hugo, extended version. 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 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.