Skip to content

docs: Clean up the community component docs#5307

Merged
clayton-cornell merged 10 commits intomainfrom
docs/cleanup-community-component-in-docs
Feb 17, 2026
Merged

docs: Clean up the community component docs#5307
clayton-cornell merged 10 commits intomainfrom
docs/cleanup-community-component-in-docs

Conversation

@clayton-cornell
Copy link
Contributor

@clayton-cornell clayton-cornell commented Jan 21, 2026

Clean up the community component doc metadata and add links

  • Removed stage: experimental metadata line
  • Removed shared text element for "Experimental"
  • Added link to Community components docs in the shared text block for community contributions

Other changes:

  • Removed some empty spaces at the end of lines, in tables, and empty lines in code samples
  • Formatted some table spacing
  • Fixed the status of otel.receiver.promethus
    • The prometheus.go file says Stability: featuregate.StabilityGenerallyAvailable, on line 34. Updated docs to state GA.
    • Line 136 in prometheus.go says enableNativeHistograms = c.opts.MinStability.Permits(featuregate.StabilityPublicPreview). Updated note to state Public Preview flag is needed to enable this feature
    • Added a debug_metrics block to the Block documentaiton section because of line 49 in prometheus.go which states DebugMetrics otelcolCfg.DebugMetricsArguments alloy:"debug_metrics,block,optional"

Not done:

  • Add community content owners to CODEOWNERS

Fixes: #5168

@clayton-cornell clayton-cornell requested a review from a team January 21, 2026 10:44
@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Jan 21, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 21, 2026

💻 Deploy preview deleted (docs: Clean up the community component docs).

jharvey10
jharvey10 previously approved these changes Jan 23, 2026
@jharvey10 jharvey10 review requested due to automatic review settings January 23, 2026 14:47
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request cleans up community component documentation to improve consistency and remove incorrect experimental stability indicators from community components.

Changes:

  • Removed stage: experimental metadata from three community component documentation files
  • Removed experimental stability shared text blocks that were incorrectly included alongside community stability blocks
  • Added a link to the Community components documentation in the shared community stability content
  • Applied formatting improvements including whitespace cleanup and consistent table formatting

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
docs/sources/shared/stability/community.md Added link to Community components page and blank line for better formatting
docs/sources/reference/components/pyroscope/pyroscope.enrich.md Removed experimental metadata and shared block; cleaned up trailing whitespace and reformatted tables
docs/sources/reference/components/otelcol/otelcol.receiver.googlecloudpubsub.md Removed experimental metadata and reformatted table separators
docs/sources/reference/components/otelcol/otelcol.receiver.awsecscontainermetrics.md Removed experimental metadata and shared block; cleaned up trailing whitespace and reformatted tables

@jharvey10 jharvey10 self-requested a review January 23, 2026 14:52
@jharvey10 jharvey10 dismissed their stale review January 23, 2026 14:52

some changes may be needed

clayton-cornell and others added 2 commits January 23, 2026 07:40
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@clayton-cornell clayton-cornell removed the backport/v1.12 Backport to release/v1.12 label Jan 26, 2026
@clayton-cornell
Copy link
Contributor Author

Not backporting this PR. There's changes to components that are in next

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.

@clayton-cornell
Copy link
Contributor Author

Broken links are fixed

Fixed the two incorrectly labeled experimental components (they were labeled as community)

Updated the status of otelcol.receiver.prometheus to GA with note about native histograms feature requiring Public Preview flag.

@clayton-cornell clayton-cornell added the backport/v1.13 Backport to release/v1.13 label Feb 10, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

@clayton-cornell clayton-cornell merged commit 7320bd4 into main Feb 17, 2026
55 checks passed
@clayton-cornell clayton-cornell deleted the docs/cleanup-community-component-in-docs branch February 17, 2026 17:15
grafana-alloybot bot pushed a commit that referenced this pull request Feb 17, 2026
Clean up the community component doc metadata and add links

* Removed `stage: experimental` metadata line
* Removed shared text element for "Experimental"
* Added link to Community components docs in the shared text block for
community contributions

Other changes:

* Removed some empty spaces at the end of lines, in tables, and empty
lines in code samples
* Formatted some table spacing
* Fixed the status of `otel.receiver.promethus`
* The `prometheus.go` file says `Stability:
featuregate.StabilityGenerallyAvailable`, on line 34. Updated docs to
state GA.
* Line 136 in `prometheus.go` says `enableNativeHistograms =
c.opts.MinStability.Permits(featuregate.StabilityPublicPreview)`.
Updated note to state Public Preview flag is needed to enable this
feature
* Added a `debug_metrics` block to the Block documentaiton section
because of line 49 in `prometheus.go` which states `DebugMetrics
otelcolCfg.DebugMetricsArguments alloy:"debug_metrics,block,optional"`

## Not done:

* Add community content owners to CODEOWNERS

Fixes: #5168

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
(cherry picked from commit 7320bd4)
clayton-cornell added a commit that referenced this pull request Feb 17, 2026
## Backport of #5307

This PR backports #5307 to release/v1.13.

### Original PR Author
@clayton-cornell

### Description
Clean up the community component doc metadata and add links

* Removed `stage: experimental` metadata line
* Removed shared text element for "Experimental"
* Added link to Community components docs in the shared text block for
community contributions

Other changes:

* Removed some empty spaces at the end of lines, in tables, and empty
lines in code samples
* Formatted some table spacing
* Fixed the status of `otel.receiver.promethus`
* The `prometheus.go` file says `Stability:
featuregate.StabilityGenerallyAvailable`, on line 34. Updated docs to
state GA.
* Line 136 in `prometheus.go` says `enableNativeHistograms =
c.opts.MinStability.Permits(featuregate.StabilityPublicPreview)`.
Updated note to state Public Preview flag is needed to enable this
feature
* Added a `debug_metrics` block to the Block documentaiton section
because of line 49 in `prometheus.go` which states `DebugMetrics
otelcolCfg.DebugMetricsArguments alloy:"debug_metrics,block,optional"`

## Not done:

* Add community content owners to CODEOWNERS

Fixes: #5168

---
*This backport was created automatically.*

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
jharvey10 pushed a commit that referenced this pull request Feb 26, 2026
Clean up the community component doc metadata and add links

* Removed `stage: experimental` metadata line
* Removed shared text element for "Experimental"
* Added link to Community components docs in the shared text block for
community contributions

Other changes:

* Removed some empty spaces at the end of lines, in tables, and empty
lines in code samples
* Formatted some table spacing
* Fixed the status of `otel.receiver.promethus`
* The `prometheus.go` file says `Stability:
featuregate.StabilityGenerallyAvailable`, on line 34. Updated docs to
state GA.
* Line 136 in `prometheus.go` says `enableNativeHistograms =
c.opts.MinStability.Permits(featuregate.StabilityPublicPreview)`.
Updated note to state Public Preview flag is needed to enable this
feature
* Added a `debug_metrics` block to the Block documentaiton section
because of line 49 in `prometheus.go` which states `DebugMetrics
otelcolCfg.DebugMetricsArguments alloy:"debug_metrics,block,optional"`

## Not done:

* Add community content owners to CODEOWNERS

Fixes: #5168

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 4, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

backport/v1.13 Backport to release/v1.13 frozen-due-to-age type/docs Docs Squad label across all Grafana Labs repos

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clean up the community component content

4 participants