Skip to content

Conversation

@adity1raut
Copy link

@adity1raut adity1raut commented Nov 9, 2025

Description

This PR Fixed #8353 refactors the Collector installation documentation by renaming, restructuring, and splitting the existing installation page into multiple focused sections. The goal is to improve clarity, organization, and navigation within the documentation.

Changes

Rename the page and update front matter:

  • Move and rename the file to index.md.

  • Add an alias in the front matter:

    aliases: [/docs/collector/installation/]
  • Create new child pages:

    • content/en/docs/collector/install/docker.mdInstall the Collector with Docker
    • content/en/docs/collector/install/kubernetes.mdInstall the Collector with Kubernetes
    • index.mdInstall from a Collector binary
    • content/en/docs/collector/install/binary/linux.mdInstall the Collector on Linux
    • content/en/docs/collector/install/binary/macos.mdInstall the Collector on macOS
    • content/en/docs/collector/install/binary/windows.mdInstall the Collector on Windows

Each new child page includes front matter with a redirect from the old location.

Content migration:

  • Keep the page title and first two paragraphs on /install/.
  • Move Docker, Docker Compose, Kubernetes, Linux, macOS, and Windows installation instructions to their respective child pages.
  • Retain the “Build from Source” section on /install/.
  • Remove the Nomad section.

Update cross-references:

  • Fix references to /docs/collector/installation/ in quick-start.md (line 131) and anywhere else within the English documentation.

Related Issues / References

  • N/A (Add issue link if applicable)

Additional Notes

This restructuring improves the logical flow and maintainability of Collector installation documentation.
Run npm run fix:all locally to ensure style and formatting compliance.

Signed-off-by: adity1raut <[email protected]>
@adity1raut adity1raut requested a review from a team as a code owner November 9, 2025 11:17
@otelbot-docs otelbot-docs bot requested review from a team and codeboten and removed request for a team November 9, 2025 11:17
Signed-off-by: adity1raut <[email protected]>
@otelbot-docs otelbot-docs bot requested a review from a team November 9, 2025 11:19
@adity1raut
Copy link
Author

PTAL @tiffany76

@theletterf theletterf requested a review from tiffany76 November 11, 2025 08:43
Copy link
Member

@tiffany76 tiffany76 left a comment

Choose a reason for hiding this comment

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

This is looking pretty good, @adity1raut! I've left some comments based on my first-pass review. Once we address those, I'll take a closer look. Thanks!

@@ -0,0 +1,140 @@
---
title: Install the Collector on Linux
aliases: [../installation/#linux]
Copy link
Member

Choose a reason for hiding this comment

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

@chalin I know this alias won't work because the source is a fragment. How do we keep the fragment's target and point it to an alert about refactoring?

Signed-off-by: adity1raut <[email protected]>
@adity1raut adity1raut requested a review from tiffany76 November 13, 2025 06:09
Signed-off-by: adity1raut <[email protected]>
@adity1raut
Copy link
Author

@tiffany76 Can you please Give me review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

[otelcol docs] Rename and split up Collector installation page

2 participants