Revamp README and add Docker serving option

Signed-off-by: lucperkins <lucperkins@gmail.com>
This commit is contained in:
lucperkins 2019-04-23 11:03:51 -07:00
parent 31451ff6b6
commit 9247c0cd9c
3 changed files with 34 additions and 5 deletions

View File

@ -1,9 +1,16 @@
HUGO_VERSION = 0.53
DOCKER_IMG := klakegg/hugo:$(HUGO_VERSION)
SERVE_CMD = server --buildDrafts --buildFuture --disableFastRender --ignoreCache
serve:
hugo server \
--buildDrafts \
--buildFuture \
--disableFastRender
docker-serve:
docker run --rm -it -v $(CURDIR):/src -p 1313:1313 $(DOCKER_IMG) $(SERVE_CMD)
production-build:
hugo \
--minify
@ -13,4 +20,4 @@ preview-build:
--baseURL $(DEPLOY_PRIME_URL) \
--buildDrafts \
--buildFuture \
--minify
--minify

View File

@ -1,4 +1,25 @@
# gRPC
This is the new [gRPC](https://grpc.io/) website, written on [Hugo](https://gohugo.io/). Here are a few key things to know about the site:
* Key variables are stored in `/config.toml`, for example `grpc_release_tag` which is used in various places throughout the site.
* If you're not familiar with Hugo, all content is stored in the `/content` directory. Go there to edit anything on the site. Images are stored in `/static/img`. Check out the [Hugo Quick Start](https://gohugo.io/getting-started/quick-start/) for a quick intro to Hugo.
# 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](https://gohugo.io) static site generator. Check out the [Hugo Quick Start](https://gohugo.io/getting-started/quick-start/) for a quick intro.
## Running the site locally
To run the site locally, you need to [install Hugo](https://gohugo.io/getting-started/installing). Once Hugo is installed:
```bash
make serve
```
Alternatively, you can run the site using a [Docker](https://docker.com) container:
```bash
make docker-serve
```
## Publishing the site
The gRPC website is automatically published by [Netlify](https://netlify.com). 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](https://www.markdownguide.org/) content used to build the site's documentation, blog, etc. is in the [`content`](./content) directory.

View File

@ -9,6 +9,7 @@ grpc_release_tag_no_v = "1.20.0"
grpc_java_release_tag = "v1.20.0"
milestones_link = "https://github.com/grpc/grpc/milestones"
# Configuration required for auto-generating the Netlify _redirects file
[mediaTypes."text/netlify"]
delimiter = ""