From 5179ab5071c1750d0b13d570d3576f366ed13832 Mon Sep 17 00:00:00 2001 From: robert Date: Fri, 24 Apr 2026 01:29:10 +0000 Subject: [PATCH] =?UTF-8?q?docs:=20hatch=20an=20egg=20into=20the=20README?= =?UTF-8?q?=20=F0=9F=90=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Documentation/README.md | 2 +- Documentation/benchmarks/README.md | 2 +- Documentation/etcd-mixin/README.md | 2 +- README.md | 2 +- client/README.md | 2 +- clientv3/README.md | 2 +- contrib/README.md | 2 +- contrib/raftexample/README.md | 2 +- etcdctl/README.md | 2 +- functional/README.md | 2 +- hack/README.md | 2 +- hack/benchmark/README.md | 2 +- hack/insta-discovery/README.md | 2 +- hack/kubernetes-deploy/README.md | 2 +- hack/patch/README.md | 2 +- hack/tls-setup/README.md | 2 +- pkg/README.md | 2 +- pkg/adt/README.md | 2 +- raft/README.md | 2 +- security/README.md | 2 +- tools/benchmark/README.md | 2 +- tools/etcd-dump-db/README.md | 2 +- tools/etcd-dump-logs/README.md | 2 +- tools/local-tester/README.md | 2 +- 24 files changed, 24 insertions(+), 24 deletions(-) diff --git a/Documentation/README.md b/Documentation/README.md index 8961c07af..122dcf6ac 100644 --- a/Documentation/README.md +++ b/Documentation/README.md @@ -1,4 +1,4 @@ -# The etcd documentation +# The etcd documentation 🐣 etcd is a distributed key-value store designed to reliably and quickly preserve and provide access to critical data. It enables reliable distributed coordination through distributed locking, leader elections, and write barriers. An etcd cluster is intended for high availability and permanent data storage and retrieval. diff --git a/Documentation/benchmarks/README.md b/Documentation/benchmarks/README.md index 33517832d..07a762bbe 100644 --- a/Documentation/benchmarks/README.md +++ b/Documentation/benchmarks/README.md @@ -1,4 +1,4 @@ -# Benchmarks +# Benchmarks 🐣 etcd benchmarks will be published regularly and tracked for each release below: diff --git a/Documentation/etcd-mixin/README.md b/Documentation/etcd-mixin/README.md index b704c0dde..238cd88e6 100644 --- a/Documentation/etcd-mixin/README.md +++ b/Documentation/etcd-mixin/README.md @@ -1,4 +1,4 @@ -# Prometheus Monitoring Mixin for etcd +# Prometheus Monitoring Mixin for etcd 🐣 > NOTE: This project is *alpha* stage. Flags, configuration, behaviour and design may change significantly in following releases. diff --git a/README.md b/README.md index 3e7e441b7..49ee0fda6 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# etcd +# 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) diff --git a/client/README.md b/client/README.md index 613ea5f33..e0b8ef0b8 100644 --- a/client/README.md +++ b/client/README.md @@ -1,4 +1,4 @@ -# etcd/client +# etcd/client 🐣 etcd/client is the Go client library for etcd. diff --git a/clientv3/README.md b/clientv3/README.md index cc8377e39..c7e54cda7 100644 --- a/clientv3/README.md +++ b/clientv3/README.md @@ -1,4 +1,4 @@ -# etcd/clientv3 +# etcd/clientv3 🐣 [![Docs](https://img.shields.io/badge/docs-latest-green.svg)](https://etcd.io/docs) [![Godoc](https://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](https://godoc.org/go.etcd.io/etcd/clientv3) diff --git a/contrib/README.md b/contrib/README.md index 10a21856b..1dd0dd990 100644 --- a/contrib/README.md +++ b/contrib/README.md @@ -1,4 +1,4 @@ -## Contrib +## Contrib 🐣 Scripts and files which may be useful but aren't part of the core etcd project. diff --git a/contrib/raftexample/README.md b/contrib/raftexample/README.md index 4ce9efd2a..958384ffb 100644 --- a/contrib/raftexample/README.md +++ b/contrib/raftexample/README.md @@ -1,4 +1,4 @@ -# raftexample +# raftexample 🐣 raftexample is an example usage of etcd's [raft library](../../raft). It provides a simple REST API for a key-value store cluster backed by the [Raft][raft] consensus algorithm. diff --git a/etcdctl/README.md b/etcdctl/README.md index 3f19812ad..831579858 100644 --- a/etcdctl/README.md +++ b/etcdctl/README.md @@ -1,4 +1,4 @@ -etcdctl +etcdctl 🐣 ======== `etcdctl` is a command line client for [etcd][etcd]. diff --git a/functional/README.md b/functional/README.md index db7815927..7a6091d4e 100644 --- a/functional/README.md +++ b/functional/README.md @@ -1,4 +1,4 @@ -## etcd Functional Testing +## etcd Functional Testing 🐣 [`functional`](https://godoc.org/github.com/coreos/etcd/functional) verifies the correct behavior of etcd under various system and network malfunctions. It sets up an etcd cluster under high pressure loads and continuously injects failures into the cluster. Then it expects the etcd cluster to recover within a few seconds. This has been extremely helpful to find critical bugs. diff --git a/hack/README.md b/hack/README.md index d337356ae..b04b3852e 100644 --- a/hack/README.md +++ b/hack/README.md @@ -1,2 +1,2 @@ -Various hacks that are used by developers. +Various hacks that are used by developers. 🐣 Hello World 2 diff --git a/hack/benchmark/README.md b/hack/benchmark/README.md index 45c14d37a..03b86dae5 100644 --- a/hack/benchmark/README.md +++ b/hack/benchmark/README.md @@ -1,4 +1,4 @@ -## Usage +## Usage 🐣 Benchmark 3-member etcd cluster to get its read and write performance. diff --git a/hack/insta-discovery/README.md b/hack/insta-discovery/README.md index af3b41623..b460fab33 100644 --- a/hack/insta-discovery/README.md +++ b/hack/insta-discovery/README.md @@ -1,2 +1,2 @@ -Starts a cluster via the discovery service locally. Useful for testing. +Starts a cluster via the discovery service locally. Useful for testing. 🐣 Hello World 2 diff --git a/hack/kubernetes-deploy/README.md b/hack/kubernetes-deploy/README.md index 8a28a813d..504988f32 100644 --- a/hack/kubernetes-deploy/README.md +++ b/hack/kubernetes-deploy/README.md @@ -1,4 +1,4 @@ -# etcd on Kubernetes +# etcd on Kubernetes 🐣 This is an example setting up etcd as a set of pods and services running on top of kubernetes. Using: diff --git a/hack/patch/README.md b/hack/patch/README.md index 45f1d1c10..62761e155 100644 --- a/hack/patch/README.md +++ b/hack/patch/README.md @@ -1,4 +1,4 @@ -# ./hack/patch/cherrypick.sh +# ./hack/patch/cherrypick.sh 🐣 Handles cherry-picks of PR(s) from etcd master to a stable etcd release branch automatically. diff --git a/hack/tls-setup/README.md b/hack/tls-setup/README.md index 137e09909..424fe14eb 100644 --- a/hack/tls-setup/README.md +++ b/hack/tls-setup/README.md @@ -1,4 +1,4 @@ -This demonstrates using Cloudflare's [cfssl](https://github.com/cloudflare/cfssl) to easily generate certificates for an etcd cluster. +This demonstrates using Cloudflare's [cfssl](https://github.com/cloudflare/cfssl) to easily generate certificates for an etcd cluster. 🐣 Defaults generate an ECDSA-384 root and leaf certificates for `localhost`. etcd nodes will use the same certificates for both sides of mutual authentication, but won't require client certs for non-peer clients. diff --git a/pkg/README.md b/pkg/README.md index 53d04ba96..3ada0914b 100644 --- a/pkg/README.md +++ b/pkg/README.md @@ -1,3 +1,3 @@ -pkg/ is a collection of utility packages used by etcd without being specific to etcd itself. A package belongs here +pkg/ is a collection of utility packages used by etcd without being specific to etcd itself. A package belongs here 🐣 only if it could possibly be moved out into its own repository in the future. Hello World 2 diff --git a/pkg/adt/README.md b/pkg/adt/README.md index 9f010a1cb..8d6e9e8bb 100644 --- a/pkg/adt/README.md +++ b/pkg/adt/README.md @@ -1,4 +1,4 @@ - + 🐣 ## Red-Black Tree *"Introduction to Algorithms" (Cormen et al, 3rd ed.), Chapter 13* diff --git a/raft/README.md b/raft/README.md index b33285d1f..4b3d998b6 100644 --- a/raft/README.md +++ b/raft/README.md @@ -1,4 +1,4 @@ -# Raft library +# Raft library 🐣 Raft is a protocol with which a cluster of nodes can maintain a replicated state machine. The state machine is kept in sync through the use of a replicated log. diff --git a/security/README.md b/security/README.md index 8f6e4c45b..2bafa2951 100644 --- a/security/README.md +++ b/security/README.md @@ -1,4 +1,4 @@ -## Security Announcements +## Security Announcements 🐣 Join the [etcd-dev](https://groups.google.com/forum/?hl=en#!forum/etcd-dev) group for emails about security and major announcements. diff --git a/tools/benchmark/README.md b/tools/benchmark/README.md index 366440fd3..c03c64b2c 100644 --- a/tools/benchmark/README.md +++ b/tools/benchmark/README.md @@ -1,4 +1,4 @@ -# etcd/tools/benchmark +# etcd/tools/benchmark 🐣 `etcd/tools/benchmark` is the official benchmarking tool for etcd clusters. diff --git a/tools/etcd-dump-db/README.md b/tools/etcd-dump-db/README.md index 4f3815715..046ce5038 100644 --- a/tools/etcd-dump-db/README.md +++ b/tools/etcd-dump-db/README.md @@ -1,4 +1,4 @@ -### etcd-dump-db +### etcd-dump-db 🐣 etcd-dump-db inspects etcd db files. diff --git a/tools/etcd-dump-logs/README.md b/tools/etcd-dump-logs/README.md index be8c49a9d..e34a51b87 100644 --- a/tools/etcd-dump-logs/README.md +++ b/tools/etcd-dump-logs/README.md @@ -1,4 +1,4 @@ -### etcd-dump-logs +### etcd-dump-logs 🐣 etcd-dump-logs dumps the log from data directory. diff --git a/tools/local-tester/README.md b/tools/local-tester/README.md index 204607a06..b27c46906 100644 --- a/tools/local-tester/README.md +++ b/tools/local-tester/README.md @@ -1,4 +1,4 @@ -# etcd local-tester +# etcd local-tester 🐣 The etcd local-tester runs a fault injected cluster using local processes. It sets up an etcd cluster with unreliable network bridges on its peer and client interfaces. The cluster runs with a constant stream of `Put` requests to simulate client usage. A fault injection script periodically kills cluster members and disrupts bridge connectivity.