Skip to content

update docs for account api tokens [LK-1497]#2427

Merged
joanasteodoro merged 1 commit into
masterfrom
update-documentation-for-new-account-token-creation-lk-1497
Jul 14, 2025
Merged

update docs for account api tokens [LK-1497]#2427
joanasteodoro merged 1 commit into
masterfrom
update-documentation-for-new-account-token-creation-lk-1497

Conversation

@joanasteodoro
Copy link
Copy Markdown
Contributor

@joanasteodoro joanasteodoro commented Jul 11, 2025

👀 Live preview

🚧 To do

  • If relevant, include the Jira issue key at the end of the pull request title
  • Perform a self-review of the changes
  • Fix any issues reported by the CI/CD

@joanasteodoro joanasteodoro requested a review from a team as a code owner July 11, 2025 15:39
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jul 11, 2025

Overall readability score: 53.05 (🟢 +0.01)

File Readability
api-tokens.md 66.47 (🟢 +2.62)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
api-tokens.md 66.47 39.94 8.84 9.9 11.07 6.74
  🟢 +2.62 🟢 +7.95 🔴 -0.06 🟢 +0.4 🟢 +0.7 🔴 -0.05

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.05 42.9 10.95 12.7 12.63 7.99
  🟢 +0.01 🟢 +0.03 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@github-actions github-actions Bot temporarily deployed to Netlify July 11, 2025 15:40 Inactive
@joanasteodoro joanasteodoro force-pushed the update-documentation-for-new-account-token-creation-lk-1497 branch from 82cbc00 to 267e666 Compare July 11, 2025 15:45
@github-actions github-actions Bot temporarily deployed to Netlify July 11, 2025 15:46 Inactive
@joanasteodoro joanasteodoro force-pushed the update-documentation-for-new-account-token-creation-lk-1497 branch from 267e666 to 94ab18e Compare July 11, 2025 15:48
@github-actions github-actions Bot temporarily deployed to Netlify July 11, 2025 15:49 Inactive
@joanasteodoro joanasteodoro force-pushed the update-documentation-for-new-account-token-creation-lk-1497 branch from 94ab18e to 9b914b5 Compare July 11, 2025 15:51
@github-actions github-actions Bot temporarily deployed to Netlify July 11, 2025 15:52 Inactive
@andrzej-janczak andrzej-janczak requested a review from Copilot July 14, 2025 08:56
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enhances the account API tokens documentation by clarifying expiration settings, adding updated screenshots, and aligning the delete workflow.

  • Added instructions for selecting expiration dates (7–90 days, custom, or none).
  • Introduced new screenshots for the creation modal and tokens table.
  • Updated language from “revoke” to “delete” and reflected the trash icon in the UI instructions.
Comments suppressed due to low confidence (3)

docs/codacy-api/api-tokens.md:32

  • [nitpick] This step is still numbered '1.' after the initial '1.' above. Consider numbering it '2.' to clearly indicate the next step.
1. Select an expiration date from the modal options. You can select between a range of 7 days to 90 days, create a custom expiration date, or create a token with no expiration.

docs/codacy-api/api-tokens.md:32

  • [nitpick] The phrase 'between a range of 7 days to 90 days' is a bit wordy. Consider rephrasing to 'between 7 and 90 days' for clarity.
1. Select an expiration date from the modal options. You can select between a range of 7 days to 90 days, create a custom expiration date, or create a token with no expiration.

docs/codacy-api/api-tokens.md:39

  • The tip still uses 'revoking' but the main action is now 'deleting'. For consistency, update this to 'deleting' only the specific token.
    You can create multiple account API tokens. This can be useful to have a more flexible control by revoking only a specific token.

Comment thread docs/codacy-api/api-tokens.md
Copy link
Copy Markdown
Contributor

@andrzej-janczak andrzej-janczak left a comment

Choose a reason for hiding this comment

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

LGTM
thanks for the doc update @joanasteodoro 💯

@joanasteodoro joanasteodoro merged commit c70000b into master Jul 14, 2025
5 checks passed
@joanasteodoro joanasteodoro deleted the update-documentation-for-new-account-token-creation-lk-1497 branch July 14, 2025 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants