DOCS-1790 - Update Access Keys and Account Preferences docs - #6982
Open
kimsauce wants to merge 6 commits into
Open
DOCS-1790 - Update Access Keys and Account Preferences docs#6982kimsauce wants to merge 6 commits into
kimsauce wants to merge 6 commits into
Conversation
Both docs were out of date against the current UI:
- access-keys.md: explicitly state that the org-wide Access Keys tab
is admin-only, distinct from Personal Access Keys.
- account-settings-preferences.md: fix the Navigation section, which
had the default/preference relationship backwards; add the missing
"Enable ingestion throttling notifications" checkbox (also admin-only,
per organization-usage-limits.md); fix a label mismatch in Log Search
("Enable autocomplete" -> "Show search autocomplete suggestions while
typing"); move Web Session Timeout under General Settings to match
the actual UI grouping; add a new Personal Authorized Apps section,
previously undocumented anywhere except a passing mention in
oauth.md; and reframe the intro to cover all three tabs under the
user menu (Preferences, Personal Access Keys, Personal Authorized
Apps) instead of just the Preferences tab.
- Renamed the "Accessing preferences" anchor to "Accessing your
account settings" to reflect the broader scope, and updated the two
external docs that linked to the old anchor.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
account-settings-preferences.md: - Reorganize under Preferences/Personal Access Keys/Personal Authorized Apps to match the actual three user-menu tabs, with a real Personal Access Keys section instead of a bare link, and a new Personal Authorized Apps section (previously undocumented). - Fix accuracy issues: Navigation preference had the default/enabled relationship backwards, "Enable autocomplete" didn't match the current UI label, ingestion throttling notifications checkbox was missing entirely, My Security Settings never explained how to start 2-Step Verification setup or where backup codes appear (now links to the authoritative 2-Step Verification for Users doc instead of a half-complete inline walkthrough). - Collapse self-explanatory settings into bullet lists instead of a heading+paragraph+screenshot per checkbox; drop screenshots that just re-illustrated a label already stated in text (My Profile, the disconnected My Preferences overview shot, the Alerts overview shot). - Various copyedits: fix double-negative/awkward phrasing, typos, wordiness, and update the org-wide vs. admin-only framing on Access Keys tab visibility for consistency with access-keys.md. access-keys.md: - Give "Create an access key" an intro naming the three creation paths, promote CORS support out from under "From a Service Account" (it applies to all three creation methods, not just service accounts), and split the org-wide policy settings (deactivation/expiration) out of "Edit, deactivate/activate, rotate, or delete access keys" into their own "Access key policies" section, since they're org-wide defaults, not actions on an individual key. - Fix the Admin-only overclaim on two policy notes and the Access Keys tab note: both are also accessible to Analysts with the relevant role capability, not Administrators exclusively. - Fix a duplicated-word typo and trim redundant sentences that restated the same role-capability requirement already stated in a note above. Also deletes three now-unused screenshots (my-profile.png, my-preferences.png, alert-preferences.png), confirmed via repo-wide grep to have no other references. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
kimsauce
marked this pull request as ready for review
August 3, 2026 22:18
The Edit/deactivate/activate section heading was reordered, breaking two external references to its old anchor.
Fixes a duplicated-word typo, an inaccurate "admin-only" simplification, inconsistent "three-dot icon" vs "three-dot kebab icon" wording, and the "Manage organization settings" capability name casing to match role-capabilities.md. Also drops a mislabeled "(Admin only)" suffix on the ingestion throttling notifications checkbox (not actually part of the UI label) and a dangling "Notifications" mention that's never covered anywhere in the doc.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose of this pull request
Both docs were out of date against the current UI.
docs/manage/security/access-keys.md:docs/get-started/account-settings-preferences.md:organization-usage-limits.md).oauth.md. Flagged two spots with TODO comments where new screenshots are needed.Select the type of change
Ticket (if applicable)
https://sumologic.atlassian.net/browse/DOCS-1790