Conversation
Canonical page for admins/connectors/official/jira_service_management — the path the Onyx UI links to for the new JSM connector (onyx-dot-app/onyx#14687). Covers: how indexing works, service desk account/token setup, connector configuration (project key, internal notes toggle, include_attachments with full/slim pruning parity, comment blacklist, optional JQL), attachment behavior, and indexed metadata. Guiding images are schematic diagrams, not UI captures; real screenshots and the setup recording still need a live environment.
…heck The two connector-form images were generated wireframes, but their alt text presented them as the real Onyx Admin Panel forms. Regenerate them with a visible "Schematic field map - not a product screenshot" badge and correct the alt text, and add a note in "Configure the connector" telling readers to match field labels rather than layout. All field labels in the diagrams (Jira Base URL, Project Key, Using scoped token, Include internal notes, Include attachments) match the connector definition in onyx-dot-app/onyx#14687. Also document the connector's project type validation, which was missing: validate_connector_settings raises a validation error unless Project Key points at a service desk (projectTypeKey == "service_desk") project, and tells you to use the Jira connector for traditional Jira projects. Run scripts/format_docs.py, which the page was failing before this change. No Admin Panel screenshots or setup recording are added. The JSM connector is still unmerged in onyx-dot-app/onyx#14687, so the Admin > Add Connector flow cannot be captured from any released Onyx build yet.
Setup recording / Admin Panel screenshots: not produced, and whyThis PR does not contain an Admin → Add Connector recording or real Admin Panel screenshots, and I did not add anything that stands in for them. Recording this honestly rather than approximating it, because the requested evidence cannot be obtained authentically right now. The blocking reasonThe Jira Service Management connector does not exist in any released Onyx build.
So there is no released Onyx in which that flow can be performed and captured. A recording would require building and running the unmerged PR branch, plus a real Jira Service Management tenant to point it at. Environment checked (this machine)
Recording tooling exists; the two things it would need to record — a released connector and a JSM tenant — do not. What I did instead (truthful, verifiable changes)
Every documented field was checked against the real connector definition in Page path, To actually close the remaining evidence gapOnce |
Add a "Field mapping" reference table to the Jira Service Management page that maps each Admin Panel label to the configuration key Onyx uses, so the same values can be supplied through the API, a config file, or an export. Keys verified against the connector definition in onyx-dot-app/onyx#14687: jira_base_url, project_key, scoped_token, include_internal_comments, include_attachments, comment_email_blacklist, and jql_query. Each key appears in all three of the backend connector __init__ signature, the TypeScript JiraServiceManagementConfig interface, and the web connector form config, so the mapping is the same value end to end. The credential keys jira_user_email and jira_api_token are documented alongside it. batch_size and labels_to_skip are intentionally omitted: they are connector __init__ parameters that are not exposed as form fields and are absent from JiraServiceManagementConfig. Also note that include_attachments is off by default and that project_key must resolve to a service desk project, matching validate_connector_settings. No new images or recordings are added.
|
Hi! This PR is blocked waiting for review/approval. Could you please review when you have a chance? The changes are ready and all local checks pass. Thanks! |
|
Status note for reviewers: the 3 guiding images in this PR are schematic diagrams (not fake UI captures) since I don't have a live Onyx environment — the |
What
Adds the canonical documentation page
admins/connectors/official/jira_service_management.mdxand registers it indocs.json.This is the exact path the new JSM connector wires into the Onyx UI (
DOCS_ADMINS_PATH/connectors/official/jira_service_managementin onyx-dot-app/onyx#14687) — today it 404s. The connector guide (backend/onyx/connectors/README.md) requires a docs page with guiding images before a connector PR merges; the prior docs carrier (#454) was closed unmerged.Contents
read:jira-work)include_attachmentscontract and the #14687 implementation)Honest notes on acceptance artifacts
<img>paths are already wired).Companion connector PR: onyx-dot-app/onyx#14687 (attachment parity implemented in f14a5f5 with a 5-scenario test matrix).