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

First step to change release life cycle info #93

Merged
merged 7 commits into from
Mar 27, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
10 changes: 5 additions & 5 deletions docs/sources/concepts/clustering.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,10 @@ Refer to component reference documentation to discover whether it supports clust
You can use the {{< param "PRODUCT_NAME" >}} UI [clustering page][] to monitor your cluster status.
Refer to [Debugging clustering issues][debugging] for additional troubleshooting information.

[run]: ../../reference/cli/run/#clustering-beta
[prometheus.scrape]: ../../reference/components/prometheus.scrape/#clustering-beta
[pyroscope.scrape]: ../../reference/components/pyroscope.scrape/#clustering-beta
[prometheus.operator.podmonitors]: ../../reference/components/prometheus.operator.podmonitors/#clustering-beta
[prometheus.operator.servicemonitors]: ../../reference/components/prometheus.operator.servicemonitors/#clustering-beta
[run]: ../../reference/cli/run/#clustering
[prometheus.scrape]: ../../reference/components/prometheus.scrape/#clustering-block
[pyroscope.scrape]: ../../reference/components/pyroscope.scrape/#clustering-block
[prometheus.operator.podmonitors]: ../../reference/components/prometheus.operator.podmonitors/#clustering-block
[prometheus.operator.servicemonitors]: ../../reference/components/prometheus.operator.servicemonitors/#clustering-block
[clustering page]: ../../tasks/debug/#clustering-page
[debugging]: ../../tasks/debug/#debugging-clustering-issues
4 changes: 3 additions & 1 deletion docs/sources/reference/cli/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,9 @@ Each {{< param "PRODUCT_NAME" >}} then transitions to the terminating state when

The current state of a clustered {{< param "PRODUCT_NAME" >}} is shown on the clustering page in the [UI][].

## Configuration conversion (beta)
## Configuration conversion

{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}

When you use the `--config.format` command-line argument with a value other than `alloy`, {{< param "PRODUCT_NAME" >}} converts the configuration file from the source format to {{< param "PRODUCT_NAME" >}} and immediately starts running with the new configuration.
This conversion uses the converter API described in the [alloy convert][] docs.
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/compatibility/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/compatibility/
canonical: https://grafana.com/docs/alloy/latest/reference/compatibility/
description: Learn about which components are compatible with each other in Grafana Alloy
title: Compatible components
Expand Down
3 changes: 2 additions & 1 deletion docs/sources/reference/components/loki.echo.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ description: Learn about loki.echo
title: loki.echo
---

<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
<span class="aliases:
- ./reference/stdlib/trim/ docs-labels__stage docs-labels__item">Public preview</span>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bad paste here I think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed


# loki.echo

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
aliases:
canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.discovery/
description: Learn about otelcol.processor.discovery
title: otelcol.processor.discovery
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ inside a `client` block.
[match_expression]: #match_expression-block
[rule]: #rule-block
[scrape]: #scrape-block
[clustering]: #clustering-beta
[clustering]: #clustering-block

### client block

Expand Down Expand Up @@ -158,7 +158,7 @@ The `operator` argument must be one of the following strings:

If there are multiple `match_expressions` blocks inside of a `selector` block, they are combined together with AND clauses.

### clustering (beta)
### clustering block

Name | Type | Description | Default | Required
---- | ---- | ----------- | ------- | --------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ The `operator` argument must be one of the following strings:

If there are multiple `match_expressions` blocks inside of a `selector` block, they are combined together with AND clauses.

### clustering (experimental)
### clustering block

Name | Type | Description | Default | Required
---- | ---- | ----------- | ------- | --------
Expand Down Expand Up @@ -188,7 +188,7 @@ fully consistent like hashmod sharding is).
If {{< param "PRODUCT_NAME" >}} is _not_ running in clustered mode, then the block is a no-op, and
`prometheus.operator.probes` scrapes every target it receives in its arguments.

[clustered mode]: ../../cli/run/#clustering-beta
[clustered mode]: ../../cli/run/#clustering

## Exported fields

Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/config-blocks/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/config-blocks/
canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/
description: Learn about configuration blocks
title: Configuration blocks
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/config-blocks/argument.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/config-blocks/argument/
canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/argument/
description: Learn about the argument configuration block
menuTitle: argument
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/config-blocks/declare.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./flow/reference/config-blocks/declare/
canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/declare/
description: Learn about the declare configuration block
menuTitle: declare
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/config-blocks/export.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/config-blocks/export/
canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/export/
description: Learn about the export configuration block
menuTitle: export
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/config-blocks/http.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/config-blocks/http/
canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/http/
description: Learn about the http configuration block
menuTitle: http
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/config-blocks/import.git.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/config-blocks/import.git/
canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/import.git/
description: Learn about the import.git configuration block
title: import.git
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/config-blocks/import.http.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/config-blocks/import.http/
canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/import.http/
description: Learn about the import.http configuration block
title: import.http
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/config-blocks/import.string.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/config-blocks/import.string/
canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/import.string/
description: Learn about the import.string configuration block
title: import.string
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/config-blocks/logging.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/config-blocks/logging/
canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/logging/
description: Learn about the logging configuration block
menuTitle: logging
Expand Down
10 changes: 3 additions & 7 deletions docs/sources/reference/config-blocks/remotecfg.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,19 @@
---
aliases:
- ./reference/config-blocks/remotecfg/
canonical: remotecfgs://grafana.com/docs/alloy/latest/reference/config-blocks/remotecfg/
description: Learn about the remotecfg configuration block
menuTitle: remotecfg
title: remotecfg block
---

# remotecfg block (beta)
# remotecfg block (public preview)

{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}

`remotecfg` is an optional configuration block that enables {{< param "PRODUCT_NAME" >}} to fetch and load the configuration from a remote endpoint.
`remotecfg` is specified without a label and can only be provided once per configuration file.

The [API definition][] for managing and fetching configuration that the `remotecfg` block uses is available under the Apache 2.0 license.

> **BETA**: The `remotecfg` enables [beta][] functionality.
> Beta features are subject to breaking changes, and may be replaced with equivalent functionality that cover the same use case.

## Example

```river
Expand Down Expand Up @@ -83,7 +80,6 @@ For example, `oauth2 > tls_config` refers to a `tls_config` block defined inside
{{< docs/shared lookup="reference/components/tls-config-block.md" source="alloy" version="<ALLOY_VERSION>" >}}

[API definition]: https://github.com/grafana/alloy-remote-config
[beta]: ../../../stability/#beta
[basic_auth]: #basic_auth-block
[authorization]: #authorization-block
[oauth2]: #oauth2-block
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/config-blocks/tracing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/config-blocks/tracing/
canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/tracing/
description: Learn about the tracing configuration block
menuTitle: tracing
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/stdlib/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/stdlib/
canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/
description: The standard library is a list of functions used in expressions when assigning values to attributes
title: Standard library
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/stdlib/coalesce.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/stdlib/coalesce/
canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/coalesce/
description: Learn about coalesce
title: coalesce
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/stdlib/concat.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/stdlib/concat/
canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/concat/
description: Learn about concat
title: concat
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/stdlib/constants.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/stdlib/constants/
canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/constants/
description: Learn about constants
title: constants
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/stdlib/env.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/stdlib/env/
canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/env/
description: Learn about env
title: env
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/stdlib/format.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/stdlib/format/
canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/format/
description: Learn about format
title: format
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/stdlib/join.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/stdlib/join/
canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/join/
description: Learn about join
title: join
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/stdlib/json_decode.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/stdlib/json_decode/
canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/json_decode/
description: Learn about json_decode
title: json_decode
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/stdlib/json_path.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/stdlib/json_path/
canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/json_path/
description: Learn about json_path
title: json_path
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/stdlib/nonsensitive.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/stdlib/nonsensitive/
canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/nonsensitive/
description: Learn about nonsensitive
title: nonsensitive
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/stdlib/replace.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- .reference/stdlib/replace/
canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/replace/
description: Learn about replace
title: replace
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/stdlib/split.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/stdlib/split/
canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/split/
description: Learn about split
title: split
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/stdlib/to_lower.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/stdlib/to_lower/
canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/to_lower/
description: Learn about to_lower
title: to_lower
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/stdlib/to_upper.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/stdlib/to_upper/
canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/to_upper/
description: Learn about to_upper
title: to_upper
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/stdlib/trim.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/stdlib/trim/
canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/trim/
description: Learn about trim
title: trim
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/stdlib/trim_prefix.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/stdlib/trim_prefix/
canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/trim_prefix/
description: Learn about trim_prefix
title: trim_prefix
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/stdlib/trim_space.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/stdlib/trim_space/
canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/trim_space/
description: Learn about trim_space
title: trim_space
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/stdlib/trim_suffix.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/stdlib/trim_suffix/
canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/trim_suffix/
description: Learn about trim_suffix
title: trim_suffix
Expand Down
20 changes: 10 additions & 10 deletions docs/sources/stability.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm assuming we plan to remove this file in favor of linking to the Grafana page?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that's a good point. I'll remove and update the PR.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
canonical: https://grafana.com/docs/alloy/latest/stability/
description: Alloy features fall into one of three stability categories, experimental, beta, or stable
description: Alloy features fall into one of three stability categories, experimental, public preview, or generally available
title: Stability
weight: 600
_build:
Expand All @@ -15,11 +15,11 @@ Stability of functionality usually refers to the stability of a _use case,_ such
Features within the {{< param "FULL_PRODUCT_NAME" >}} project will fall into one of three stability categories:

* **Experimental**: A new use case is being explored.
* **Beta**: Functionality covering a use case is being matured.
* **Stable**: Functionality covering a use case is believed to be stable.
* **Public preview**: Functionality covering a use case is being matured.
* **Generally available**: Functionality covering a use case is believed to be stable.

The default stability is stable.
Features are explicitly marked as experimental or beta if they aren't stable.
Features are explicitly marked as experimental or public preview if they aren't stable.

## Experimental

Expand All @@ -30,21 +30,21 @@ exploring a new use case, and would like feedback.
* Experimental features can be removed with no equivalent replacement.
* Experimental features may require enabling feature flags to use.

Unless removed, experimental features eventually graduate to beta.
Unless removed, experimental features eventually graduate to public preview.

## Beta
## Public preview

The **beta** stability category is used to denote a feature which is being matured.
The **public preview** stability category is used to denote a feature which is being matured.

* Beta features are subject to occasional breaking changes.
* Beta features can be replaced by equivalent functionality that covers the same use case.
* Beta features can be used without enabling feature flags.

Unless replaced with equivalent functionality, beta features eventually graduate to stable.
Unless replaced with equivalent functionality, public preview features eventually graduate to generally available.

## Stable
## Generally available

The **stable** stability category is used to denote a feature as stable.
The **generally available** stability category is used to denote a feature as stable.

* Breaking changes to stable features are rare, and will be well-documented.
* If new functionality is introduced to replace existing stable functionality, deprecation and removal timeline will be well-documented.
Expand Down
1 change: 0 additions & 1 deletion docs/sources/tasks/configure-alloy-clustering.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,5 @@ To configure clustering:
1. Ensure that all expected nodes appear in the resulting table.

[clustering]: ../../concepts/clustering/
[beta]: ../../stability/#beta
[install-helm]: ../../get-started/install/kubernetes/
[UI]: ../debug/#component-detail-page
Loading