From 548f715271e47f72f8e403e0b26c1b43365caa00 Mon Sep 17 00:00:00 2001 From: Gyuho Lee Date: Mon, 27 Aug 2018 19:19:36 -0700 Subject: [PATCH] README: update repo URLs Signed-off-by: Gyuho Lee --- README.md | 52 ++++++++++++++++++++++------------------------------ 1 file changed, 22 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 42c1e18f5..ff53815e1 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,16 @@ - - -**WARNING**: etcd will be transferred from https://github.com/coreos to https://github.com/etcd-io, on 5PM PST, Mon, August 27, 2018. See https://github.com/coreos/etcd/issues/9965 for detailed timeline. - - # etcd -[![Go Report Card](https://goreportcard.com/badge/github.com/coreos/etcd?style=flat-square)](https://goreportcard.com/report/github.com/coreos/etcd) -[![Coverage](https://codecov.io/gh/coreos/etcd/branch/master/graph/badge.svg)](https://codecov.io/gh/coreos/etcd) -[![Build Status Travis](https://img.shields.io/travis/coreos/etcdlabs.svg?style=flat-square&&branch=master)](https://travis-ci.org/coreos/etcd) -[![Build Status Semaphore](https://semaphoreci.com/api/v1/coreos/etcd/branches/master/shields_badge.svg)](https://semaphoreci.com/coreos/etcd) +[![Go Report Card](https://goreportcard.com/badge/github.com/etcd-io/etcd?style=flat-square)](https://goreportcard.com/report/github.com/etcd-io/etcd) +[![Coverage](https://codecov.io/gh/etcd-io/etcd/branch/master/graph/badge.svg)](https://codecov.io/gh/etcd-io/etcd) +[![Build Status Travis](https://img.shields.io/travis/etcd-io/etcdlabs.svg?style=flat-square&&branch=master)](https://travis-ci.org/etcd-io/etcd) +[![Build Status Semaphore](https://semaphoreci.com/api/v1/etcd-io/etcd/branches/master/shields_badge.svg)](https://semaphoreci.com/etcd-io/etcd) [![Docs](https://readthedocs.org/projects/etcd/badge/?version=latest&style=flat-square)](https://etcd.readthedocs.io/en/latest/?badge=latest) -[![Godoc](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](https://godoc.org/github.com/coreos/etcd) -[![Releases](https://img.shields.io/github/release/coreos/etcd/all.svg?style=flat-square)](https://github.com/coreos/etcd/releases) -[![LICENSE](https://img.shields.io/github/license/coreos/etcd.svg?style=flat-square)](https://github.com/coreos/etcd/blob/master/LICENSE) +[![Godoc](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](https://godoc.org/github.com/etcd-io/etcd) +[![Releases](https://img.shields.io/github/release/etcd-io/etcd/all.svg?style=flat-square)](https://github.com/etcd-io/etcd/releases) +[![LICENSE](https://img.shields.io/github/license/etcd-io/etcd.svg?style=flat-square)](https://github.com/etcd-io/etcd/blob/master/LICENSE) **Note**: The `master` branch may be in an *unstable or even broken state* during development. Please use [releases][github-release] instead of the `master` branch in order to get stable binaries. -*the etcd v2 [documentation](Documentation/v2/README.md) has moved* - ![etcd Logo](logos/etcd-horizontal-color.svg) etcd is a distributed reliable key-value store for the most critical data of a distributed system, with a focus on being: @@ -29,7 +22,7 @@ etcd is a distributed reliable key-value store for the most critical data of a d etcd is written in Go and uses the [Raft][raft] consensus algorithm to manage a highly-available replicated log. -etcd is used [in production by many companies](./Documentation/production-users.md), and the development team stands behind it in critical deployment scenarios, where etcd is frequently teamed with applications such as [Kubernetes][k8s], [locksmith][locksmith], [vulcand][vulcand], [Doorman][doorman], and many others. Reliability is further ensured by [**rigorous testing**](https://github.com/coreos/etcd/tree/master/functional). +etcd is used [in production by many companies](./Documentation/production-users.md), and the development team stands behind it in critical deployment scenarios, where etcd is frequently teamed with applications such as [Kubernetes][k8s], [locksmith][locksmith], [vulcand][vulcand], [Doorman][doorman], and many others. Reliability is further ensured by [**rigorous testing**](https://github.com/etcd-io/etcd/tree/master/functional). See [etcdctl][etcdctl] for a simple command line client. @@ -38,13 +31,16 @@ See [etcdctl][etcdctl] for a simple command line client. [doorman]: https://github.com/youtube/doorman [locksmith]: https://github.com/coreos/locksmith [vulcand]: https://github.com/vulcand/vulcand -[etcdctl]: https://github.com/coreos/etcd/tree/master/etcdctl +[etcdctl]: https://github.com/etcd-io/etcd/tree/master/etcdctl ## Community meetings -etcd contributors and maintainers have bi-weekly meetings at 11:00 AM (USA Pacific) on Tuesdays. Anyone is welcome to join via [BlueJeans][bluejeans]. An initial agenda will be posted to the [shared Google docs][shared-meeting-notes] a day before each meeting, and everyone is welcome to suggest additional topics or other agendas. +*Community meeting is put on hold for now.* + +etcd contributors and maintainers have bi-weekly meetings at 11:00 AM (USA Pacific) on Tuesdays. + +An initial agenda will be posted to the [shared Google docs][shared-meeting-notes] a day before each meeting, and everyone is welcome to suggest additional topics or other agendas. -[bluejeans]: https://bluejeans.com/2732309610 [shared-meeting-notes]: https://docs.google.com/document/d/16XEGyPBisZvmmoIHSZzv__LoyOeluC5a4x353CX0SIM/edit ## Getting started @@ -53,11 +49,11 @@ etcd contributors and maintainers have bi-weekly meetings at 11:00 AM (USA Pacif The easiest way to get etcd is to use one of the pre-built release binaries which are available for OSX, Linux, Windows, and Docker on the [release page][github-release]. -For more installation guides, please check out [play.etcd.io](http://play.etcd.io) and [operating etcd](https://github.com/coreos/etcd/tree/master/Documentation#operating-etcd-clusters). +For more installation guides, please check out [play.etcd.io](http://play.etcd.io) and [operating etcd](https://github.com/etcd-io/etcd/tree/master/Documentation#operating-etcd-clusters). For those wanting to try the very latest version, [build the latest version of etcd][dl-build] from the `master` branch. This first needs [*Go*](https://golang.org/) installed (version 1.10+ is required). All development occurs on `master`, including new features and bug fixes. Bug fixes are first targeted at `master` and subsequently ported to release branches, as described in the [branch management][branch-management] guide. -[github-release]: https://github.com/coreos/etcd/releases +[github-release]: https://github.com/etcd-io/etcd/releases [branch-management]: ./Documentation/branch_management.md [dl-build]: ./Documentation/dl_build.md#build-the-latest-version @@ -67,20 +63,20 @@ First start a single-member cluster of etcd. If etcd is installed using the [pre-built release binaries][github-release], run it from the installation location as below: -```sh +```bash /tmp/etcd-download-test/etcd ``` The etcd command can be simply run as such if it is moved to the system path as below: -```sh +```bash mv /tmp/etcd-download-test/etcd /usr/local/bin/ etcd ``` If etcd is [built from the master branch][dl-build], run it as below: -```sh +```bash ./bin/etcd ``` @@ -110,7 +106,7 @@ First install [goreman](https://github.com/mattn/goreman), which manages Procfil Our [Procfile script](./Procfile) will set up a local example cluster. Start it with: -```sh +```bash goreman start ``` @@ -118,10 +114,6 @@ This will bring up 3 etcd members `infra1`, `infra2` and `infra3` and etcd `grpc Every cluster member and proxy accepts key value reads and key value writes. -### Running etcd on Kubernetes - -To run an etcd cluster on Kubernetes, try [etcd operator](https://github.com/coreos/etcd-operator). - ### Next steps Now it's time to dig into the full etcd API and other guides. @@ -146,8 +138,8 @@ Now it's time to dig into the full etcd API and other guides. - Mailing list: [etcd-dev](https://groups.google.com/forum/?hl=en#!forum/etcd-dev) - IRC: #[etcd](irc://irc.freenode.org:6667/#etcd) on freenode.org -- Planning/Roadmap: [milestones](https://github.com/coreos/etcd/milestones), [roadmap](./ROADMAP.md) -- Bugs: [issues](https://github.com/coreos/etcd/issues) +- Planning/Roadmap: [milestones](https://github.com/etcd-io/etcd/milestones), [roadmap](./ROADMAP.md) +- Bugs: [issues](https://github.com/etcd-io/etcd/issues) ## Contributing