Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

websited: Removed ghpages handling; fixed docs; and status badge. #1084

Merged
merged 1 commit into from
Apr 27, 2019
Merged

websited: Removed ghpages handling; fixed docs; and status badge. #1084

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 0 additions & 16 deletions Makefile
View file
Open in desktop
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
17 changes: 15 additions & 2 deletions README.md
View file
Open in desktop
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 Expand Up @@ -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-<data>-<sha>`.

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)
11 changes: 7 additions & 4 deletions docs/contributing/how-to-contribute-to-docs.md
View file
Open in desktop
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.
2 changes: 1 addition & 1 deletion website/hugo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ relativeURL: true
contentDir: "docs-pre-processed"
archetypeDir: "archetypes"
layoutDir: "layouts"
publishDi: "public"
publishDir: "public"
staticDir: "static"

permalinks:
Expand Down