Skip to content

docs(controller): cross-link user sign-in and API token sections#7324

Merged
sanderson merged 1 commit into
telegraf-controller-gafrom
docs/controller-auth-crosslinks
Jun 12, 2026
Merged

docs(controller): cross-link user sign-in and API token sections#7324
sanderson merged 1 commit into
telegraf-controller-gafrom
docs/controller-auth-crosslinks

Conversation

@jstirnaman

Copy link
Copy Markdown
Contributor

Summary

  • Adds a scope note to /telegraf/controller/authentication/ stating that the section covers user sign-in, with a link to Manage API tokens for API and agent authentication.
  • Adds the corresponding note to /telegraf/controller/tokens/ linking to Authentication for user sign-in.
  • Normalizes two stray CRLF line endings in authentication/_index.md to LF.

The authentication/ section documents user sign-in providers only; API authentication is documented under tokens/ and the API reference (#7314). These notes route readers between the two at the top of each section landing page.

authentication/_index.md and tokens/_index.md both set weight: 8. This PR leaves the weights unchanged: 9–11 are assigned to settings, licensing, and audit logs, so distinct values require renumbering those pages. The current tie resolves alphabetically (Authentication before Manage API tokens).

Pages to preview

URL Expected
/telegraf/controller/authentication/ First paragraph states the section covers user sign-in and links to Manage API tokens
/telegraf/controller/tokens/ Second paragraph links to Authentication for user sign-in

Checklist

  • Vale: 0 errors on both files

@jstirnaman jstirnaman requested a review from a team as a code owner June 11, 2026 16:29
@jstirnaman jstirnaman requested review from sanderson and removed request for a team June 11, 2026 16:29
@jstirnaman jstirnaman added the product:telegraf Telegraf documentation label Jun 11, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Vale Style Check Results

Metric Count
Errors 0
Warnings 0
Suggestions 0

Check passed

@github-actions

Copy link
Copy Markdown
Contributor
PR Preview Action v1.4.8
🚀 Deployed preview to https://influxdata.github.io/docs-v2/pr-preview/pr-7324/
on branch gh-pages at 2026-06-11 16:32 UTC

@sanderson sanderson merged commit 1b21d59 into telegraf-controller-ga Jun 12, 2026
22 checks passed
@sanderson sanderson deleted the docs/controller-auth-crosslinks branch June 12, 2026 21:57
github-actions Bot added a commit that referenced this pull request Jun 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:telegraf Telegraf documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants