diff --git a/Makefile b/Makefile index 55e0057fd2..7eb4bce5d5 100644 --- a/Makefile +++ b/Makefile @@ -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)) diff --git a/README.md b/README.md index 316aa25e81..f48762b886 100644 --- a/README.md +++ b/README.md @@ -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 @@ -60,14 +60,27 @@ The philosophy of Thanos and our community is borrowing much from UNIX philosoph * Make it easy to read, write, and, run components * e.g. reduce complexity in system design and implementation +## Releases + +Master should be stable and usable. Every commit to master builds docker image named `master--`. + +We also perform minor releases every 6 weeks. +During that, wee build tarballs for major platforms and docker image. + +See [this](docs/release-process.md) for details. + ## Contributing Contributions are very welcome! See our [CONTRIBUTING.md](CONTRIBUTING.md) for more information. ## Community -Thanos is an open source project and we welcome new contributers and members +Thanos is an open source project and we value and welcome new contributors and members of the community. Here are ways to get in touch with the community: * Slack: [#thanos](https://join.slack.com/t/improbable-eng/shared_invite/enQtMzQ1ODcyMzQ5MjM4LWY5ZWZmNGM2ODc5MmViNmQ3ZTA3ZTY3NzQwOTBlMTkzZmIxZTIxODk0OWU3YjZhNWVlNDU3MDlkZGViZjhkMjc) * Issue Tracker: [GitHub Issues](https://github.com/improbable-eng/thanos/issues) + +## Maintainers + +See [MAINTAINERS.md](MAINTAINERS.md) \ No newline at end of file diff --git a/docs/contributing/how-to-contribute-to-docs.md b/docs/contributing/how-to-contribute-to-docs.md index c3c65578d2..1c7a8837e6 100644 --- a/docs/contributing/how-to-contribute-to-docs.md +++ b/docs/contributing/how-to-contribute-to-docs.md @@ -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. \ No newline at end of file +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. \ No newline at end of file diff --git a/website/hugo.yaml b/website/hugo.yaml index 4b530f9a59..472134ab6f 100644 --- a/website/hugo.yaml +++ b/website/hugo.yaml @@ -19,7 +19,7 @@ relativeURL: true contentDir: "docs-pre-processed" archetypeDir: "archetypes" layoutDir: "layouts" -publishDi: "public" +publishDir: "public" staticDir: "static" permalinks: