rancher / rancher/stackstate-product-docs

[STAC-25560] (Topology) Identifiers documentation is confusing

Open Beginner friendly
#397 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/documentation JIRA kind/enhancement
Dominant language
Shell
Stars
2
Forks
24
Avg merge
4d 3h
Merged PRs (30d)
16

Description

STAC-25560

There is a reference page for (Topology) Identifiers that turns out to be about identifiers in general. It is still using a syntax that comes from the agent topology support so we should update or remove that part (including the part of the integration identifier).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the Identifiers reference page linked in the issue and review which content describes identifiers generally versus the agent topology syntax. Update or remove the outdated syntax, including the integration identifier section, then verify the page clearly documents identifiers in general without the confusing topology-specific guidance.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
75/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.