Add M2M insights documentation#6017
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdded Machine-to-Machine (M2M) as an activity option in Organization Insights, introduced an "M2M Authentications" graph for newly issued M2M tokens, extended latency wording to include logins/registrations/M2M token usage, expanded filters to include M2M ( Changes
Suggested labels
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
en/includes/guides/organization-insights.md (2)
157-170: Bold "Protocol section" as a UI element.On line 161, "Protocol section" refers to a specific UI section/tab and should be formatted in bold, consistent with the guideline to format UI labels and sections in bold.
✨ Proposed formatting update
- <td>Filter M2M token requests based on the client ID of an M2M application in your organization.</br></br> - (You can find the client ID of an application from the Protocol section of the application on the {{ product_name }} Console.)</br></br> + <td>Filter M2M token requests based on the client ID of an M2M application in your organization.</br></br> + (You can find the client ID of an application from the <b>Protocol</b> section of the application on the {{ product_name }} Console.)</br></br> Example for a client ID: <code>rXJ4z9k2mL8pQvN5wX1aB3</code>Otherwise, the M2M filter documentation is clear, well-structured, and follows the established table pattern.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/guides/organization-insights.md` around lines 157 - 170, The UI label "Protocol section" in the Client ID description should be formatted in bold to match UI element styling; find the table row containing the "Client ID" cell (text string "Client ID" and the sentence containing "Protocol section of the application on the {{ product_name }} Console") and change the plain text "Protocol section" to bold formatting so it renders as a UI label in the documentation.
74-74: Bold activity names for UI consistency.The activity names (Login, Registration, M2M) should be bold when referring to selectable UI options, consistent with how they appear in the activity list (lines 14-16) and the guideline to format UI labels in bold.
✨ Proposed formatting update
-1. On the {{ product_name }} Console, go to **Insights**, and select an activity (Login, Registration, or M2M). +1. On the {{ product_name }} Console, go to **Insights**, and select an activity (**Login**, **Registration**, or **M2M**).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/guides/organization-insights.md` at line 74, Update the sentence that reads "On the {{ product_name }} Console, go to **Insights**, and select an activity (Login, Registration, or M2M)." so the activity names are formatted in bold to match UI label styling; change "(Login, Registration, or M2M)" to "(**Login**, **Registration**, or **M2M**)" ensuring only the activity labels are bolded and punctuation/spacing remains consistent.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/includes/guides/organization-insights.md`:
- Line 61: Update the sentence in the organization insights guide that reads
"This graph in M2M insights represents the number of new M2M tokens issued to
your organizations within the selected duration." to use singular "organization"
for consistency with the rest of the document; change "your organizations" to
"your organization" in the content of organization-insights.md (the sentence
describing the graph in M2M insights).
- Line 66: Replace the incorrect URL used for the "client credentials grant"
link in the markdown line that currently points to
{{base_path}}/guides/authentication/oidc/implement-auth-code/#prerequisites;
update the href to
{{base_path}}/references/grant-types/#client-credentials-grant so the link text
"client credentials grant" points to the correct client credentials grant
documentation in organization-insights.md.
---
Nitpick comments:
In `@en/includes/guides/organization-insights.md`:
- Around line 157-170: The UI label "Protocol section" in the Client ID
description should be formatted in bold to match UI element styling; find the
table row containing the "Client ID" cell (text string "Client ID" and the
sentence containing "Protocol section of the application on the {{ product_name
}} Console") and change the plain text "Protocol section" to bold formatting so
it renders as a UI label in the documentation.
- Line 74: Update the sentence that reads "On the {{ product_name }} Console, go
to **Insights**, and select an activity (Login, Registration, or M2M)." so the
activity names are formatted in bold to match UI label styling; change "(Login,
Registration, or M2M)" to "(**Login**, **Registration**, or **M2M**)" ensuring
only the activity labels are bolded and punctuation/spacing remains consistent.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: f728c236-c0e0-47a3-baa4-441004af6383
⛔ Files ignored due to path filters (1)
en/asgardeo/docs/assets/img/guides/organization-insights/m2m-authentications-graph.pngis excluded by!**/*.png
📒 Files selected for processing (1)
en/includes/guides/organization-insights.md
pavinduLakshan
added
Team/API Access Mgt & Authorization
Team/Asgardeo
and removed
Team/API Access Mgt & Authorization
labels
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
en/includes/guides/organization-insights.md (1)
61-61: Use one metric term consistently in the M2M graph description.Line 61 says the graph shows “new M2M tokens issued” but then says it shows “M2M token requests.” Pick one term (preferably “tokens issued”) to avoid ambiguity.
Suggested fix
-This graph in M2M insights represents the number of new M2M tokens issued to your organization within the selected duration. By hovering your mouse over a point on the graph, you can view the specific count of M2M token requests for each day. +This graph in M2M insights represents the number of new M2M tokens issued to your organization within the selected duration. By hovering your mouse over a point on the graph, you can view the specific count of issued M2M tokens for each day.As per coding guidelines: "Use one term per concept; do not switch terminology mid-document".
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/guides/organization-insights.md` at line 61, The description sentence for the M2M graph is inconsistent—change the phrase that reads "M2M token requests" to use the same term as earlier ("new M2M tokens issued") so the line reads consistently (e.g., "This graph in M2M insights represents the number of new M2M tokens issued to your organization within the selected duration. By hovering your mouse over a point on the graph, you can view the specific count of new M2M tokens issued for each day."); update the sentence in the document fragment shown in the diff to replace "M2M token requests" with "new M2M tokens issued".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/includes/guides/organization-insights.md`:
- Around line 60-61: Change the heading "M2M Authentications" to sentence case
("M2M authentications") and insert a blank line immediately after the heading to
satisfy MD022; update the heading text where it appears (the line containing
"M2M Authentications") and ensure one empty line separates that heading from the
following paragraph.
- Around line 31-34: The Markdown has two consecutive blank lines between the
paragraph ending "including logins, registrations, and M2M token usage." and the
heading "## User engagement metrics", causing MD012; remove the extra blank line
so there is exactly one blank line between that paragraph and the "## User
engagement metrics" heading to resolve the lint failure.
---
Nitpick comments:
In `@en/includes/guides/organization-insights.md`:
- Line 61: The description sentence for the M2M graph is inconsistent—change the
phrase that reads "M2M token requests" to use the same term as earlier ("new M2M
tokens issued") so the line reads consistently (e.g., "This graph in M2M
insights represents the number of new M2M tokens issued to your organization
within the selected duration. By hovering your mouse over a point on the graph,
you can view the specific count of new M2M tokens issued for each day."); update
the sentence in the document fragment shown in the diff to replace "M2M token
requests" with "new M2M tokens issued".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: 4d9ab3bc-7cec-4647-bd5c-ac4954ff1c9c
📒 Files selected for processing (1)
en/includes/guides/organization-insights.md
| There is a latency of up to 20 minutes between the user activity and insights. This delay ensures accurate data processing and allows for a more comprehensive analysis of all activities including logins, registrations, and M2M token usage. | ||
|
|
||
|
|
||
| ## User engagement metrics |
There was a problem hiding this comment.
Remove the extra blank line to fix Markdown lint failure (MD012).
There are two consecutive blank lines after Line 32, which triggers the pipeline error at Line 33. Keep only one blank line.
Suggested fix
- There is a latency of up to 20 minutes between the user activity and insights. This delay ensures accurate data processing and allows for a more comprehensive analysis of all activities including logins, registrations, and M2M token usage.
-
-
+ There is a latency of up to 20 minutes between the user activity and insights. This delay ensures accurate data processing and allows for a more comprehensive analysis of all activities including logins, registrations, and M2M token usage.
+
## User engagement metrics🧰 Tools
🪛 GitHub Actions: Markdown Lint
[error] 33-33: markdownlint-cli2 (markdownlint v0.38.0) failed: MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]. https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md012.md
🪛 GitHub Check: lint
[failure] 34-34: Headings should be surrounded by blank lines
en/includes/guides/organization-insights.md:34 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## User engagement metrics"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md022.md
[failure] 33-33: Multiple consecutive blank lines
en/includes/guides/organization-insights.md:33 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md012.md
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/includes/guides/organization-insights.md` around lines 31 - 34, The
Markdown has two consecutive blank lines between the paragraph ending "including
logins, registrations, and M2M token usage." and the heading "## User engagement
metrics", causing MD012; remove the extra blank line so there is exactly one
blank line between that paragraph and the "## User engagement metrics" heading
to resolve the lint failure.
RushanNanayakkara
force-pushed
the
master
branch
from
2c3d987 to
29b2e3f
Compare
There was a problem hiding this comment.
♻️ Duplicate comments (2)
en/includes/guides/organization-insights.md (2)
60-61:⚠️ Potential issue | 🟡 MinorUse sentence case for the heading and add a blank line below it.
Change
### M2M Authenticationsto sentence case (for example,### M2M authentications) and insert one blank line before the following paragraph to satisfyMD022.As per coding guidelines: "Use sentence case for all headings and document titles, capitalizing only the first word and proper nouns."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/guides/organization-insights.md` around lines 60 - 61, Change the heading text "### M2M Authentications" to sentence case "### M2M authentications" and add one blank line after that heading so the paragraph below is separated (fixes MD022); update the heading string in the organization-insights.md section containing "M2M Authentications" to the new casing and ensure a single empty line follows it before the paragraph that starts "This graph in M2M insights...".
31-34:⚠️ Potential issue | 🟡 MinorFix consecutive blank lines before the section heading.
There are two blank lines before
## User engagement metrics, which triggersMD012. Keep exactly one blank line.As per coding guidelines: "Ensure headings are sentence case, procedures use numbered lists, UI labels are in bold, code elements and paths are in backticks, links use descriptive text, content is concise and active voice, and no unverified claims, placeholders, or sensitive data appear in examples."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/guides/organization-insights.md` around lines 31 - 34, Remove the extra blank line before the "## User engagement metrics" heading so there is exactly one blank line between the preceding paragraph ("There is a latency...") and the heading to satisfy MD012; locate the heading token "## User engagement metrics" and collapse the two consecutive empty lines into a single empty line, then scan nearby headings to ensure they follow sentence case and other style rules (headings in sentence case, UI labels bold, code/paths in backticks, links descriptive) as needed.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@en/includes/guides/organization-insights.md`:
- Around line 60-61: Change the heading text "### M2M Authentications" to
sentence case "### M2M authentications" and add one blank line after that
heading so the paragraph below is separated (fixes MD022); update the heading
string in the organization-insights.md section containing "M2M Authentications"
to the new casing and ensure a single empty line follows it before the paragraph
that starts "This graph in M2M insights...".
- Around line 31-34: Remove the extra blank line before the "## User engagement
metrics" heading so there is exactly one blank line between the preceding
paragraph ("There is a latency...") and the heading to satisfy MD012; locate the
heading token "## User engagement metrics" and collapse the two consecutive
empty lines into a single empty line, then scan nearby headings to ensure they
follow sentence case and other style rules (headings in sentence case, UI labels
bold, code/paths in backticks, links descriptive) as needed.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: 58ebfd4e-015f-4fa9-b5b2-00d564619101
📒 Files selected for processing (1)
en/includes/guides/organization-insights.md
- Fix MD012: remove extra blank line before ## User engagement metrics - Fix MD022: add blank lines after all headings - Fix MD047: add trailing newline at end of file - Fix MD022: add blank line after ### M2M authentications - Fix grammar: "organizations" → "organization" - Fix link: client credentials grant URL corrected - Bold activity names (Login, Registration, M2M) and Protocol section - Fix heading case: M2M Authentications → M2M authentications Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
3 participants
Purpose
Introduce M2M Insights documentation