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

Docs: remove unnecessary lists of sections #3790

Merged
merged 1 commit into from
Jun 3, 2021
Merged
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
33 changes: 2 additions & 31 deletions docs/sources/configuration/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,35 +10,6 @@ depending on which mode Loki is launched in.

Configuration examples can be found in the [Configuration Examples](examples/) document.

- [Configuring Loki](#configuring-loki)
- [Printing Loki Config At Runtime](#printing-loki-config-at-runtime)
- [Configuration File Reference](#configuration-file-reference)
- [server_config](#server_config)
- [distributor_config](#distributor_config)
- [querier_config](#querier_config)
- [query_frontend_config](#query_frontend_config)
- [queryrange_config](#queryrange_config)
- [ruler_config](#ruler_config)
- [frontend_worker_config](#frontend_worker_config)
- [ingester_client_config](#ingester_client_config)
- [ingester_config](#ingester_config)
- [consul_config](#consul_config)
- [etcd_config](#etcd_config)
- [compactor_config](#compactor_config)
- [memberlist_config](#memberlist_config)
- [storage_config](#storage_config)
- [chunk_store_config](#chunk_store_config)
- [cache_config](#cache_config)
- [schema_config](#schema_config)
- [period_config](#period_config)
- [limits_config](#limits_config)
- [grpc_client_config](#grpc_client_config)
- [table_manager_config](#table_manager_config)
- [provision_config](#provision_config)
- [auto_scaling_config](#auto_scaling_config)
- [tracing_config](#tracing_config)
- [Runtime Configuration file](#runtime-configuration-file)

## Printing Loki Config At Runtime

If you pass Loki the flag `-print-config-stderr` or `-log-config-reverse-order`, (or `-print-config-stderr=true`)
Expand Down Expand Up @@ -92,7 +63,7 @@ Where default_value is the value to use if the environment variable is undefined

Pass the `-config.expand-env` flag at the command line to enable this way of setting configs.

### Generic placeholders:
### Generic placeholders

- `<boolean>` : a boolean that can take the values `true` or `false`
- `<int>` : any integer matching the regular expression `[1-9]+[0-9]*`
Expand All @@ -104,7 +75,7 @@ Pass the `-config.expand-env` flag at the command line to enable this way of set
- `<string>` : a regular string
- `<secret>` : a regular string that is a secret, such as a password

### Supported contents and default values of `loki.yaml`:
### Supported contents and default values of `loki.yaml`

```yaml
# The module to run Loki with. Supported values
Expand Down
15 changes: 0 additions & 15 deletions docs/sources/configuration/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,6 @@ title: Examples
---
# Loki Configuration Examples

- [Loki Configuration Examples](#loki-configuration-examples)
- [Complete Local config](#complete-local-config)
- [Google Cloud Storage](#google-cloud-storage)
- [Cassandra Index](#cassandra-index)
- [AWS](#aws)
- [S3-compatible APIs](#s3-compatible-apis)
- [S3 Expanded Config](#s3-expanded-config)
- [Almost zero dependencies setup](#almost-zero-dependencies-setup)
- [schema_config](#schema_config)
- [Query Frontend](#query-frontend)

## Complete Local config

```yaml
Expand Down Expand Up @@ -274,7 +263,3 @@ configs:
period: 168h
prefix: index_
```

## Query Frontend

[example configuration](../query-frontend/)
3 changes: 0 additions & 3 deletions docs/sources/maintaining/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,3 @@ weight: 1200
# Loki Maintainers Guide

This section details information for maintainers of Loki.

1. [Releasing Loki](release/)
1. [Releasing `loki-build-image`](release-loki-build-image/)
26 changes: 0 additions & 26 deletions docs/sources/storage/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,32 +18,6 @@ More detailed information can be found on the [operations page]({{< relref "../o

Some more storage details can also be found in the [operations section]({{< relref "../operations/storage/_index.md" >}}).

- [Storage](#storage)
- [Implementations - Chunks](#implementations---chunks)
- [Cassandra](#cassandra)
- [GCS](#gcs)
- [File System](#file-system)
- [S3](#s3)
- [Notable Mentions](#notable-mentions)
- [Implementations - Index](#implementations---index)
- [Single Store (boltdb-shipper) - Recommended for 2.0 and newer](#single-store)
- [Cassandra](#cassandra-1)
- [BigTable](#bigtable)
- [DynamoDB](#dynamodb)
- [Rate Limiting](#rate-limiting)
- [BoltDB](#boltdb)
- [Schema Configs](#schema-configs)
- [Table Manager](#table-manager)
- [Provisioning](#provisioning)
- [Upgrading Schemas](#upgrading-schemas)
- [Retention](#retention)
- [Examples](#examples)
- [Single machine/local development (boltdb+filesystem)](#single-machinelocal-development-boltdbfilesystem)
- [GCP deployment (GCS Single Store)](#gcp-deployment-gcs-single-store)
- [AWS deployment (S3+DynamoDB)](#aws-deployment-s3dynamodb)
- [On prem deployment (Cassandra+Cassandra)](#on-prem-deployment-cassandracassandra)
- [On prem deployment (MinIO Single Store)](#on-prem-deployment-minio-single-store)

## Implementations - Chunks

### Cassandra
Expand Down