Skip to content

Conversation

sg-writer
Copy link
Contributor

@sg-writer sg-writer commented Oct 14, 2025

https://linear.app/ngrok/issue/DOC-408/update-documentation-to-replace-bot-user-with-service-user

This PR:

  • replaces remaining instances of "Bot User" with "Service User" (with the exception of the bot user API reference page)
  • capitalizes Service User and Bot User everywhere
  • adds a new API reference page for service users
  • replaces the sidebar nav link to the bot user API reference with the new service user reference
  • adds callouts at the top of both API reference pages to clarify the situation
  • copyedits both API reference pages and the iam/service-users page
  • adds a definition popup for the term "service user" that mentions it used to be called "bot user"

@sg-writer sg-writer added docs/content Changes to the written material in the docs priority/high kind/outdated-info Addresses info in the docs that may be outdated or no longer applicable labels Oct 14, 2025
@sg-writer sg-writer changed the title Replace all instances of "bot user" with "service user" Replace all (most) instances of "bot user" with "service user" Oct 15, 2025
@sg-writer sg-writer requested a review from iambmelt October 15, 2025 21:10
@sg-writer sg-writer marked this pull request as ready for review October 15, 2025 21:13
Copy link
Contributor

@iambmelt iambmelt left a comment

Choose a reason for hiding this comment

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

LGTM

### Response

Returns a 200 response on success
Returns a 200 response on success.
Copy link
Contributor

Choose a reason for hiding this comment

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

IIRC this also returns a copy of the updated entity on PATCH

@sg-writer sg-writer changed the title Replace all (most) instances of "bot user" with "service user" Replace all (most) instances of "Bot User" with "Service User" Oct 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs/content Changes to the written material in the docs kind/outdated-info Addresses info in the docs that may be outdated or no longer applicable priority/high

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants