Skip to content

Commit

Permalink
websited: Removed ghpages handling; fixed docs; and status badge.
Browse files Browse the repository at this point in the history
Signed-off-by: Bartek Plotka <[email protected]>
  • Loading branch information
bwplotka committed Apr 25, 2019
1 parent f539a90 commit cc6cee9
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 21 deletions.
16 changes: 0 additions & 16 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -244,22 +244,6 @@ web-serve: web-pre-process $(HUGO)
@echo ">> serving documentation website"
@cd $(WEB_DIR) && $(HUGO) --config hugo.yaml -v server

# Deprecated.
.PHONY: web-gh-pages-deploy
web-deploy:
# Requires git creds configured beforehand.
$(call require_clean_work_tree,"deploy website")
@rm -rf $(PUBLIC_DIR)
@mkdir $(PUBLIC_DIR)
@git worktree prune
@rm -rf .git/worktrees/$(PUBLIC_DIR)/
@git fetch origin
@git worktree add -B gh-pages $(PUBLIC_DIR) origin/gh-pages
@rm -rf $(PUBLIC_DIR)/*
@make web
@cd $(PUBLIC_DIR) && git add --all && git commit -m "Publishing to gh-pages as $(ME)" && cd ..
@git push origin gh-pages

# non-phony targets
$(EMBEDMD):
$(call fetch_go_bin_version,github.com/campoy/embedmd,$(EMBEDMD_VERSION))
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![GoDoc](https://godoc.org/github.com/improbable-eng/thanos?status.svg)](https://godoc.org/github.com/improbable-eng/thanos)
[![Slack](https://img.shields.io/badge/join%20slack-%23thanos-brightgreen.svg)](https://join.slack.com/t/improbable-eng/shared_invite/enQtMzQ1ODcyMzQ5MjM4LWY5ZWZmNGM2ODc5MmViNmQ3ZTA3ZTY3NzQwOTBlMTkzZmIxZTIxODk0OWU3YjZhNWVlNDU3MDlkZGViZjhkMjc)
[![Docker Pulls](https://img.shields.io/docker/pulls/improbable/thanos.svg?maxAge=604800)](https://hub.docker.com/r/improbable/thanos/)
[![Netlify Status](https://api.netlify.com/api/v1/badges/664a5091-934c-4b0e-a7b6-bc12f822a590/deploy-status)](https://app.netlify.com/sites/kind-mayer-9cc74b/deploys)
[![Netlify Status](https://api.netlify.com/api/v1/badges/664a5091-934c-4b0e-a7b6-bc12f822a590/deploy-status)](https://app.netlify.com/sites/thanos-io/deploys)

## Overview

Expand Down
11 changes: 7 additions & 4 deletions docs/contributing/how-to-contribute-to-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,16 @@ Show new menu section in main page by changing `website/layouts/_default/baseof.

## Testing

Run `make web-serve` to serve and preview the website locally.
Every PR is building website and on success it shows the link to preview.

Alternatively you can run `make web-serve` to serve and preview the website locally.

## Deployment.

Ask maintainer to deploy the page. (`GOOGLE_ANALYTICS_TOKEN="< >" make web-deploy`)
We use [Netlify](https://www.netlify.com/) for hosting. We are using Open Source license (PRO). Thanks Netlify for this!

NOTE: It might take couple of seconds to refresh page / CDN for Github pages.
On every commit to `master` netlify runs CI that invokes `make web` (defined in [netlify.toml](https://github.com/improbable-eng/thanos/blob/master/netlify.toml)))

TODO(bwplotka) CI job which does that on every master commit.
NOTE: Check for status badge in README for build status on the page.

If master build for netlify succeed, the new content is published automatically.

0 comments on commit cc6cee9

Please sign in to comment.