From 3b7e1223ab36aa52cfc7ef8fe8bc4cec196a57a2 Mon Sep 17 00:00:00 2001 From: James Blair Date: Sun, 4 Jun 2023 22:39:48 +1200 Subject: [PATCH 1/3] Fix errors in README.md reported by markdownlint. Signed-off-by: James Blair --- README.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 524a30bcd..65a6e5e64 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,6 @@ The easiest way to get etcd is to use one of the pre-built release binaries whic For more installation guides, please check out [play.etcd.io](http://play.etcd.io) and [operating etcd](https://etcd.io/docs/latest/op-guide). [github-release]: https://github.com/etcd-io/etcd/releases -[branch-management]: https://etcd.io/docs/latest/branch_management ### Running etcd @@ -74,15 +73,15 @@ This will bring up etcd listening on port 2379 for client communication and on p Next, let's set a single key, and then retrieve it: -``` +```bash etcdctl put mykey "this is awesome" etcdctl get mykey ``` etcd is now running and serving client requests. For more, please check out: -- [Interactive etcd playground](http://play.etcd.io) -- [Animated quick demo](https://etcd.io/docs/latest/demo) +* [Interactive etcd playground](http://play.etcd.io) +* [Animated quick demo](https://etcd.io/docs/latest/demo) ### etcd TCP ports @@ -120,13 +119,13 @@ go get go.etcd.io/etcd/client/v3 Now it's time to dig into the full etcd API and other guides. -- Read the full [documentation][]. -- Explore the full gRPC [API][]. -- Set up a [multi-machine cluster][clustering]. -- Learn the [config format, env variables and flags][configuration]. -- Find [language bindings and tools][integrations]. -- Use TLS to [secure an etcd cluster][security]. -- [Tune etcd][tuning]. +* Read the full [documentation][]. +* Explore the full gRPC [API][]. +* Set up a [multi-machine cluster][clustering]. +* Learn the [config format, env variables and flags][configuration]. +* Find [language bindings and tools][integrations]. +* Use TLS to [secure an etcd cluster][security]. +* [Tune etcd][tuning]. [documentation]: https://etcd.io/docs/latest [api]: https://etcd.io/docs/latest/learning/api @@ -138,9 +137,9 @@ Now it's time to dig into the full etcd API and other guides. ## Contact -- Email: [etcd-dev](https://groups.google.com/forum/?hl=en#!forum/etcd-dev) -- Slack: [#etcd](https://kubernetes.slack.com/messages/C3HD8ARJ5/details/) channel on Kubernetes ([get an invite](http://slack.kubernetes.io/)) -- [Community meetings](#Community-meetings) +* Email: [etcd-dev](https://groups.google.com/forum/?hl=en#!forum/etcd-dev) +* Slack: [#etcd](https://kubernetes.slack.com/messages/C3HD8ARJ5/details/) channel on Kubernetes ([get an invite](http://slack.kubernetes.io/)) +* [Community meetings](#community-meetings) ### Community meetings From 41b5e2174810800b3f8459043ac2d4528fb4e0e2 Mon Sep 17 00:00:00 2001 From: James Blair Date: Mon, 5 Jun 2023 21:32:03 +1200 Subject: [PATCH 2/3] Add a checklist for reporting bugs, include faq link. Signed-off-by: James Blair --- .github/ISSUE_TEMPLATE/bug-report.yml | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 53e4e88ea..84930ee4b 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,14 +1,23 @@ --- name: Bug Report -description: Report a bug encountered while operating Etcd +description: Report a bug encountered while operating etcd labels: - type/bug body: + - type: checkboxes + id: confirmations + attributes: + label: Bug report criteria + description: Please confirm this bug report meets the following criteria. + options: + - label: This bug report is not security related, security issues should be disclosed privately via security@etcd.io. + - label: This is not a support request, support requests should be raised in the etcd [discussion forums](https://github.com/etcd-io/etcd/discussions). + - label: You have read the etcd [bug reporting guidelines](https://github.com/etcd-io/etcd/blob/main/Documentation/contributor-guide/reporting_bugs.md). + - label: Existing open issues along with etcd [frequently asked questions](https://etcd.io/docs/latest/faq) have been checked and this is not a duplicate. + - type: markdown attributes: value: | - Please read https://github.com/etcd-io/etcd/blob/main/Documentation/contributor-guide/reporting_bugs.md - If this matter is security related, please disclose it privately via security@etcd.io. Please fill the form below and provide as much information as possible. Not doing so may result in your bug not being addressed in a timely manner. @@ -90,4 +99,4 @@ body: attributes: label: Relevant log output description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. - render: shell + render: Shell From 4a2fdb8ba887b7cfbb3f5279ebcf1321fca0154c Mon Sep 17 00:00:00 2001 From: James Blair Date: Mon, 5 Jun 2023 21:32:28 +1200 Subject: [PATCH 3/3] Promote faqs in README.md. Signed-off-by: James Blair --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 65a6e5e64..fef87865b 100644 --- a/README.md +++ b/README.md @@ -119,8 +119,9 @@ go get go.etcd.io/etcd/client/v3 Now it's time to dig into the full etcd API and other guides. -* Read the full [documentation][]. -* Explore the full gRPC [API][]. +* Read the full [documentation]. +* Review etcd [frequently asked questions]. +* Explore the full gRPC [API]. * Set up a [multi-machine cluster][clustering]. * Learn the [config format, env variables and flags][configuration]. * Find [language bindings and tools][integrations]. @@ -166,7 +167,9 @@ Please refer to [community-membership.md](Documentation/contributor-guide/commun ## Reporting bugs -See [reporting bugs](https://github.com/etcd-io/etcd/blob/main/Documentation/contributor-guide/reporting_bugs.md) for details about reporting any issues. +See [reporting bugs](https://github.com/etcd-io/etcd/blob/main/Documentation/contributor-guide/reporting_bugs.md) for details about reporting any issues. Before opening an issue please check it is not covered in our [frequently asked questions]. + +[frequently asked questions]: https://etcd.io/docs/latest/faq ## Reporting a security vulnerability