Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grpc/grpc.io
Repository for the gRPC website and documentation
https://github.com/grpc/grpc.io
Last synced: about 1 month ago
JSON representation
Repository for the gRPC website and documentation
- Host: GitHub
- URL: https://github.com/grpc/grpc.io
- Owner: grpc
- License: other
- Created: 2019-04-23T00:01:50.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T23:43:40.000Z (6 months ago)
- Last Synced: 2024-05-23T00:42:10.528Z (6 months ago)
- Language: HTML
- Homepage: https://grpc.io
- Size: 202 MB
- Stars: 410
- Watchers: 26
- Forks: 405
- Open Issues: 100
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
- Governance: GOVERNANCE.md
Awesome Lists containing this project
README
# 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**.
Install it using **[nvm][]**, for example:
```console
$ nvm install --lts
```
## Setup
1. Clone this repo.
2. From a terminal window, change to the cloned repo directory.
3. Get NPM packages and git submodules, including the the [Docsy][] theme:
```console
$ npm install
```
## Build the site
Run the following command to have Hugo generate the site files:
```console
$ 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:
```console
$ npm run serve
```
## Setup Google Analytics (GA) and Google Tag Manager (GTM)
1. **Google Analytics (GA):**
- Follow the [GA setup guide](https://support.google.com/analytics/answer/9304153) to create your account, property, and data stream.
- Update `config.yaml` with your GA Measurement ID:
```yaml
params:
googleAnalytics: "G-XXXXXXXXXX" # Replace with your GA Measurement ID
```
Verify GA setup using real-time reports to ensure data from your website is being tracked.
2. **Google Tag Manager (GTM):**
- Follow the [GTM setup guide](https://developers.google.com/tag-platform/tag-manager/web) to create your account and container.
- Update `config.yaml` with your GTM ID:
```yaml
params:
gtmID: "GTM-XXXXXXXX" # Replace with your GTM ID
```
Check GTM setup using Preview mode and verify that Tag Assistant displays "Connected" for your website URL.
Build the site by setting Hugo environment to production to make sure GA and GTM work.
```console
$ HUGO_ENV=production npm run serve
```
## Site deploys and PR previews
If you submit a PR, Netlify will create a [deploy preview][] so that you can
review your changes. Once your PR is merged, Netlify deploys the updated site to
the production server.
> **Note**: PR previews include _draft pages_, but production builds do not.
To see deploy logs and more, visit project's [dashboard][] -- Netlify login
required.
## Check links
If you have [htmltest][] in your path, then
you can check the site's **internal** links by running this command:
```console
$ npm run check-links
```
You can check all links (internal and external) as well:
```console
$ npm run check-links:all
```
## Contribute
We welcome issues and PRs! For details, see [Contribute][].
[Contribute]: https://grpc.io/community/#contribute
[dashboard]: https://app.netlify.com/teams/grpc/overview
[deploy preview]: https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/
[Docsy]: https://www.docsy.dev
[grpc.io]: https://grpc.io
[htmltest]: https://github.com/wjdp/htmltest
[Hugo]: https://gohugo.io
[localhost:8888]: http://localhost:8888
[LTS release]: https://nodejs.org/en/about/releases/
[Netlify]: https://netlify.com
[nvm]: https://github.com/nvm-sh/nvm/blob/master/README.md#installing-and-updating