sadoneli / grpc.io

Repository for the gRPC website and documentation

gRPC website

The grpc.io site, built using Hugo and hosted on Netlify.

Build prerequisites

To build and serve the site, you'll need the latest LTS release of Node. Like Netlify, we use nvm, the Node Version Manager, to install and manage Node versions:

$ nvm install --lts

Setup

1. Clone or download a copy of this repo.
2. From a terminal window, change to the cloned or unzipped repo directory.
3. Get NPM packages and git submodules, including the the Docsy theme:

   $ npm install 

Build the site

Run the following command to have Hugo generate the site files:

$ npm run build

You'll find the generated site files in the public folder.

Serve the site locally

To locally serve the site at localhost:8888, run the following command:

$ npm run serve

Site deploys and PR previews

If you submit a PR, Netlify will automatically create a deploy preview so that you can review your changes. Once your PR is merged, Netlify automcatically deploys to the production site grpc.io.

Note: PR previews include draft pages, but production builds do not.

You can see deploy logs and more from the Netlify gRPC Team dashboard, provided you have the necessary permissions.

Check links

If you have htmltest in your path, then you can check the site's internal links by running this command:

$ npm run check-links

You can check all links (internal and external) as well:

$ npm run check-links:all

Contribute

We welcome issues and PRs! For details, see Contribute.