Repository navigation
docs(jans-fido2): split long notes in passkey-telemetry into sections - #15239
Conversation
Signed-off-by: imran <imranishaq7071@gmail.com>
|
Important Review skippedReview was skipped as selected files did not have any reviewable changes.
 |
| Layer / File(s) | Summary |
|---|---|
Telemetry metric interpretation docs/janssen-server/fido/passkey-telemetry.md |
Guidance on first-factor metrics, attempt status, usernameless ceremonies, rates, and biometric failures is presented as headings and prose. |
Request context and relay forwarding docs/janssen-server/fido/passkey-telemetry.md, docs/janssen-server/fido/fido2-server-properties-config.md |
Guidance on value limits, relay forwarding, HTTPS, and trusted relays is presented under headings. The properties page now links to the relay section. |
Correlation and telemetry configuration docs/janssen-server/fido/passkey-telemetry.md |
Correlation, legacy aggregation, and metric reporter guidance is reorganized into headings and prose. |
Priority:
Estimated code review effort: 2 (Simple) | ~8 minutes
Change: Other · Severity of issue fixed: Low
Merge Risk: 
2791a
-
The documentation reorganization presents no identified obstacle to merging.
Architecture risk: 
2791a
-
The change affects 1 system.
Changed systems:
docsArchitecture concerns
No architecture-level concerns identified.Review details
-
Systems and components
- observed — docs (service) was modified; 2 changed files map to changed impact.
Before / after behavior
- observed — Modified behavior in docs/janssen-server/fido/fido2-server-properties-config.md: The link now points to “Requests relayed by the Authorization Server and Casa” instead of “Request context on raw entries.”
- observed — Modified behavior in docs/janssen-server/fido/passkey-telemetry.md: The first-factor metrics note is now plain text: username/password authentication is not handled by FIDO2, and its metrics are found in the Authorization Server.
- observed — Modified behavior in docs/janssen-server/fido/passkey-telemetry.md: The
ATTEMPTversus completion note is now a heading and prose, retaining that an attempt without a matching terminal entry may be in flight or dropped off, makingdropOffRatean inference. - observed — Modified behavior in docs/janssen-server/fido/passkey-telemetry.md: The usernameless-ceremony note is now a heading and paragraphs. It retains that these ceremonies are not swept or counted as abandonment, remain pending for normal cleanup, and that
abandonmentRatecovers named-user ceremonies.
-
🚥 Pre-merge checks | ✅ 4 | ❌ 1
-
❌ Failed checks (1 warning)
Check name Status Explanation Resolution Linked Issues check ⚠️ WarningThe PR implements the requested restructuring in [ #15238]. It converts the callouts to prose or linkable sections, splits the relay content into sections for relayed requests, HTTPS forwarding, and re…Restore the exact ATTEMPT vs. completionwording and restoreTwo consequences worth knowing:. Keep the required section restructuring and cross-reference update.✅ Passed checks (4 passed)
-
Check name Status Explanation Title check ✅ Passed The title clearly summarizes the main documentation change: splitting long notes in the passkey telemetry document into sections. Description check ✅ Passed The description follows the repository template, identifies the target issue, explains the documentation changes, records validation performed, and explains why the full MkDocs build and code tests we… Out of Scope Changes check ✅ Passed The changes are limited to passkey-telemetry.mdandfido2-server-properties-config.md. The section restructuring and cross-reference update directly support [#15238]. No unrelated change is shown.Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Linked Issues check
-
Explanation
The PR implements the requested restructuring in [
#15238]. It converts the callouts to prose or linkable sections, splits the relay content into sections for relayed requests, HTTPS forwarding, and relay trust, and updates the cross-reference infido2-server-properties-config.md. The current diff changesATTEMPT vs. completiontoAttempts and completions, although [#15238] requires wording to remain unchanged. The PR summary also reports removal ofTwo consequences worth knowing:. No automated test change is required for this documentation-only issue.
-
✨ Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Autopilot is currently an internal CodeRabbit preview.
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 help to get the list of available commands.
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
mo-auto
added
area-documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| who cancelled immediately — both surface as `NotAllowedError` in the browser and as an | ||
| `abandoned` ceremony here. A `FAILURE` means the server rejected an assertion it received, which | ||
| in practice means a protocol-level problem rather than a user who could not verify. | ||
| ### An unknown rate is `null`, not zero |
There was a problem hiding this comment.
Please remove , and back-ticks from titles.
Also adapt title to be more like a section title and not a note header.
For example, one of the inappropriate title in the text below is
Not the `metricReporter*` properties
But at the same time, one below is better.
HTTPS requirement for forwarding
Signed-off-by: imran <imranishaq7071@gmail.com>
Prepare
Description
Target issue
closes #15238
Follow-up to review comments from @ossdhaval on #15223, which was merged before they were addressed.
Implementation Details
Docs-only; no code touched.
passkey-telemetry.mdhad 11!!!notes/warnings, several long ones. Admonitionscan't be linked to and break the reading flow, so they are converted to sections or prose:
###/####section, or plain prose where it was short(the first-factor note and the correlation opt-in note).
HTTPS requirement for forwarding and Trusting the relays in FIDO2. "Behind a reverse proxy" also becomes
a section.
retention section is dropped, since it announced two items and was followed by a single note.
Python-Markdown). The callout in
fido2-server-properties-config.mdnow links to the new relay section.Not run locally: the full mkdocs site build (the theme plugins aren't installed here); the Docs CI check covers it.
Test and Document the changes
Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with
docs:to indicate documentation changes or if the below checklist is not selected.Summary by CodeRabbit