Skip to content

[otelcol docs] Rename and split up Collector installation page #8353

@tiffany76

Description

@tiffany76

What needs to be changed?

The Collector installation page needs to be renamed and broken apart into child pages.

What is the name + path of the page that needs changed?

https://opentelemetry.io/docs/collector/installation/

Additional context:

There are several tasks needed to complete this issue:

  • Rename /docs/collector/installation/ to /docs/collector/install/
  • Add an alias to the front matter pointing to the old page
  • Create new child pages:
    • docs/collector/install/docker/ - "Install the Collector with Docker"
    • docs/collector/install/kubernetes/ - "Install the Collector with Kubernetes"
    • docs/collector/install/binary/ - "Install from a Collector binary"
    • docs/collector/install/binary/linux/ - "Install the Collector on Linux"
    • docs/collector/install/binary/macos/ - "Install the Collector on macOS"
    • docs/collector/install/binary/windows/ - "Install the Collector on Windows"
  • Add front matter for each new page that includes a redirect which points to the new page
  • Keep the page title and the first two paragraphs on the /install/ landing page
  • Cut and paste the remaining content onto the new child pages
  • Delete the Nomad content
  • Keep the Build from Source content on the /install/ page (for now)
  • Correct any cross-references to the old /installation/ page
    • docs/collector/quickstart.md: line 131
    • Run a search across the en docs for any other instances of the old page and fix them

Tip:
React
with 👍 to help prioritize this issue. Please use comments to provide useful
context, avoiding +1 or me too, to help us triage it. Learn more
here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    IAInformation architecture reworkcollector-refactorThese issues are part of the Collector documentation refactoring project.help wantedExtra attention is neededsig:collector

    Type

    Projects

    Status

    No status

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions