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
389 Commits 1 Branch 0 Tags 212 MiB
HTML 53%
SCSS 36.4%
Shell 8.7%
Makefile 1.9%
Go to file
Jiangtao Li 46b0c24a20
Add ALTS auth guide (#301) 
* Add ALTS auth guide

* Move alts_auth.md to guides/auth/ALTS.md

* Fix ALTS link

* Address reviewer's comments

* Split ALTS.md into two pages.

* Revert "Split ALTS.md into two pages."

This reverts commit 55dbbd9986.

* Address reviewer comments

* Address Cesar's comments

* Remove GCP specific info. Make ALTS guide more generic
 		2020-07-02 05:32:09 -04:00
.github/ISSUE_TEMPLATE Issue template: drop title from blank template 2020-03-26 11:09:25 -04:00
archetypes More blog post cleanup 2020-03-10 11:36:12 -07:00
assets/sass Fix side menu scrolling (#264) 2020-06-18 11:53:30 -04:00
content Add ALTS auth guide (#301) 2020-07-02 05:32:09 -04:00
data gRPC Go officially supports Go 1.12+ (#268) 2020-06-05 13:56:58 -04:00
layouts 404 page rework, including title fix to the title (#330) 2020-07-01 13:47:35 -04:00
static Add "grpc-web interceptors" blog entry (#292) 2020-06-18 11:08:51 -04:00
themes Add docsy theme submodule w/o using it (#228) 2020-05-18 14:25:01 -04:00
.browerslistrc Adjust column width for main documentation text (#186) 2020-04-13 17:54:57 -04:00
.editorconfig Convert contributing guide to Markdown 2020-03-09 16:01:17 -07:00
.gitignore README: list prerequisites and include step to run npm install (#189) 2020-04-14 17:25:12 -04:00
.gitmodules Add docsy theme submodule w/o using it (#228) 2020-05-18 14:25:01 -04: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
LICENSE-DOCS Add DOCS license file (#174) 2020-04-10 16:28:55 -04:00
MAINTAINERS.md Add MAINTAINERS file (#232) 2020-05-22 09:03:58 -04:00
Makefile Upgrade to hugo 0.70.0 (#226) 2020-05-16 03:08:55 -04:00
README.md README: list prerequisites and include step to run npm install (#189) 2020-04-14 17:25:12 -04:00
check_hugo.sh Ensure Hugo is properly installed 2020-03-18 13:23:50 -07:00
config.yaml 404 page rework, including title fix to the title (#330) 2020-07-01 13:47:35 -04:00
deploy.sh Add contents of new site repo 2019-04-22 18:07:24 -07:00
netlify.toml Netlify config: set Node.js version (#227) 2020-05-16 03:37:36 -04:00
package.json Add docsy theme submodule w/o using it (#228) 2020-05-18 14:25:01 -04:00
postcss.config.js Adjust column width for main documentation text (#186) 2020-04-13 17:54:57 -04:00
yarn.lock Adjust column width for main documentation text (#186) 2020-04-13 17:54:57 -04: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.

Prerequisites

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.