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.

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

Documentation Content: TOC — Version/Home sidebar Descriptions #12554

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions Documentation/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: etcd version ___
weight: 1000
nate-double-u marked this conversation as resolved.
Show resolved Hide resolved
---

These docs cover everything from setting up and running an etcd cluster to using etcd in applications. Improvements to these docs are encouraged through [pull requests](https://help.github.com/en/articles/about-pull-requests) to the [etcd project](https://github.com/etcd-io/etcd) on GitHub.
3 changes: 2 additions & 1 deletion Documentation/branch-management.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Branch management
weight: 1
weight: 1250
description: etcd branch management
---

## Guide
Expand Down
3 changes: 2 additions & 1 deletion Documentation/demo.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Demo
weight: 1
weight: 1100
description: Procedures for working with an etcd cluster
---

This series of examples shows the basic procedures for working with an etcd cluster.
Expand Down
2 changes: 2 additions & 0 deletions Documentation/dev-internal/discovery_protocol.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Discovery service protocol
weight: 1500
description: Discover other etcd members in a cluster bootstrap phase
---

Discovery service protocol helps new etcd member to discover all other members in cluster bootstrap phase using a shared discovery URL.
Expand Down
2 changes: 2 additions & 0 deletions Documentation/dev-internal/logging.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Logging conventions
weight: 1600
description: Logging level categories
---

etcd uses the [capnslog][capnslog] library for logging application output categorized into *levels*. A log message's level is determined according to these conventions:
Expand Down
4 changes: 3 additions & 1 deletion Documentation/dev-internal/modules.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Golang modules
weight: 1650
description: Organization of the etcd project's golang modules
---

The etcd project (since version 3.5) is organized into multiple
Expand Down Expand Up @@ -92,4 +94,4 @@ This assumes:
etcd storage files.
- Splitting etcd-proxy out of ./etcd binary, as it contains more experimental code
so carries additional risk & dependencies.
- Deprecation of support for v2 protocol.
- Deprecation of support for v2 protocol.
2 changes: 2 additions & 0 deletions Documentation/dev-internal/release.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: etcd release guide
weight: 1550
description: How to release a new version of etcd
---

The guide talks about how to release a new version of etcd.
Expand Down
2 changes: 2 additions & 0 deletions Documentation/dl-build.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Download and build
weight: 1150
description: Instructions for downloading and building different versions of etcd
---

## System requirements
Expand Down
4 changes: 3 additions & 1 deletion Documentation/faq.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Frequently Asked Questions (FAQ)
title: FAQ
weight: 1200
description: Frequently asked questions
---

## etcd, general
Expand Down
2 changes: 2 additions & 0 deletions Documentation/integrations.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Libraries and tools
weight: 1300
description: A listing of etcd tools and client libraries
---

## Tools
Expand Down
2 changes: 2 additions & 0 deletions Documentation/metrics.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Metrics
weight: 1350
description: Metrics for real-time monitoring and debugging
---

etcd uses [Prometheus][prometheus] for metrics reporting. The metrics can be used for real-time monitoring and debugging. etcd does not persist its metrics; if a member restarts, the metrics will be reset.
Expand Down
2 changes: 2 additions & 0 deletions Documentation/reporting-bugs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Reporting bugs
weight: 1400
description: How to file issue reports for the etcd project
---

If any part of the etcd project has bugs or documentation mistakes, please let us know by [opening an issue][etcd-issue]. We treat bugs and mistakes very seriously and believe no issue is too small. Before creating a bug report, please check that an issue reporting the same problem does not already exist.
Expand Down
2 changes: 2 additions & 0 deletions Documentation/rfc/v3api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Overview
weight: 1050
description: etcd API design principles
---

The etcd v3 API is designed to give users a more efficient and cleaner abstraction compared to etcd v2. There are a number of semantic and protocol changes in this new API.
Expand Down
2 changes: 2 additions & 0 deletions Documentation/tuning.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Tuning
weight: 1450
description: When to update the heartbeat interval and election timeout settings
---

The default settings in etcd should work well for installations on a local network where the average network latency is low. However, when using etcd across multiple data centers or over networks with high latency, the heartbeat interval and election timeout settings may need tuning.
Expand Down