Add user attribute push rules documentation - #65
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:
📝 WalkthroughWalkthroughAdds documentation and navigation for an Attribute Push Rules feature and a docs-writing guideline: a new admin guide for push rules, a nav entry, and a note to use the Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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
🤖 Fix all issues with AI agents
In `@product/admin/attribute-push-rules.mdx`:
- Line 28: Replace the vague line "You manually trigger a push" with a short,
actionable how-to: add a brief step-by-step for the UI (e.g., navigate to
Settings → Attributes → click "Push now" or similar button) and an alternative
CLI/API example (e.g., show the CLI command or POST /attributes/push endpoint
and required auth/payload) so users know where to perform the action; update the
copy in product/admin/attribute-push-rules.mdx replacing the phrase "You
manually trigger a push" with these concrete instructions and include
one-sentence notes about expected results and where to find logs/status.
- Line 36: The prerequisite text "User attribute mappings defined in
ConductorOne (Admin > Settings > User data sources)" is ambiguous; update the
copy in attribute-push-rules.mdx to briefly explain what "user attribute
mappings" are, how to verify them (e.g., confirm required attributes like
email/username are mapped to source fields in Admin > Settings > User data
sources), and add a link to the ConductorOne docs or the User data sources
settings page for step-by-step instructions; reference the exact phrase "User
attribute mappings defined in ConductorOne (Admin > Settings > User data
sources)" when editing so readers can quickly find and replace the line with the
clarified text and link.
🧹 Nitpick comments (3)
product/admin/attribute-push-rules.mdx (3)
12-12: Consider breaking up this long sentence for improved readability.The sentence contains multiple use cases connected by "as well as," making it a bit dense. Consider restructuring into a bulleted list or separate sentences.
✨ Suggested refactor for clarity
-Use attribute push rules when you need to keep user profile data synchronized across applications or populate custom user fields in connected applications. They're also helpful for maintaining consistent user attributes for compliance or operational purposes, as well as transforming or deriving attribute values before syncing to applications. +Use attribute push rules when you need to: + +- Keep user profile data synchronized across applications +- Populate custom user fields in connected applications +- Maintain consistent user attributes for compliance or operational purposes +- Transform or derive attribute values before syncing to applications
71-85: Consider documenting available user fields for CEL expressions.The CEL examples reference fields like
user.first_name,user.last_name, anduser.department, but the documentation doesn't explain what fields are available on theuserobject. Adding a reference to available attributes would help users write their own expressions.Consider adding a note like:
Note: You can reference any ConductorOne user attribute in your CEL expressions using
user.attribute_name. See the Attributes tab in User data sources for available attributes.
44-44: Optional: Consider varying the phrasing to avoid repetition.The phrase "you want to sync" follows a similar pattern used earlier ("you want to push" on line 18). While this is natural in instructional content, you could vary it slightly for stylistic consistency. As per coding guidelines, LanguageTool identified this as repetitive phrasing.
✍️ Alternative phrasing
-5. For each attribute you want to sync: +5. For each attribute to sync:
|
|
||
| - The push configuration is created or updated | ||
| - A user's attribute values change in ConductorOne | ||
| - You manually trigger a push |
There was a problem hiding this comment.
Clarify how to manually trigger a push.
The documentation mentions that attributes are pushed when "you manually trigger a push," but doesn't explain how to perform this action. Users may be unclear about where to find this capability.
Would you like me to help draft instructions for manually triggering a push, or should this capability be documented in a separate section?
🤖 Prompt for AI Agents
In `@product/admin/attribute-push-rules.mdx` at line 28, Replace the vague line
"You manually trigger a push" with a short, actionable how-to: add a brief
step-by-step for the UI (e.g., navigate to Settings → Attributes → click "Push
now" or similar button) and an alternative CLI/API example (e.g., show the CLI
command or POST /attributes/push endpoint and required auth/payload) so users
know where to perform the action; update the copy in
product/admin/attribute-push-rules.mdx replacing the phrase "You manually
trigger a push" with these concrete instructions and include one-sentence notes
about expected results and where to find logs/status.
- Add complete frontmatter (og:title, og:description, sidebarTitle) - Convert procedural steps to <Steps> components - Tighten intro into scannable bullet list - Convert "when to use" section to bullet list - Fix navigation path formatting (> instead of \>) - Rename "Map to ConductorOne attributes" to "Direct attribute mapping" - Rename "Use CEL expressions" to "CEL expressions" - Remove redundant "(CEL expression)" from heading - Minor copy edits for conciseness Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add note to docs-writing skill: use `go` for CEL expressions (CEL not recognized) - Update attribute-push-rules.mdx code blocks from `cel` to `go` Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@product/admin/push-rules.mdx`:
- Around line 72-74: The tab label text is inconsistent: change the Step element
content that reads "Select the **Push rule** tab." (and the other occurrence at
lines 106–107) to match the actual UI label; update both instances to the
correct plural form "Select the **Push rules** tab." so the document
consistently matches the UI.
2 participants
New docs page for attribute push rules
Summary by CodeRabbit