Skip to content

RHIDP-10933: [Doc] ServiceNow plugin: Allow integration without changing ServiceNow infrastructure#2020

Open
rh-tokeefe wants to merge 16 commits into
redhat-developer:mainfrom
rh-tokeefe:RHIDP-10933
Open

RHIDP-10933: [Doc] ServiceNow plugin: Allow integration without changing ServiceNow infrastructure#2020
rh-tokeefe wants to merge 16 commits into
redhat-developer:mainfrom
rh-tokeefe:RHIDP-10933

Conversation

@rh-tokeefe
Copy link
Copy Markdown
Member

@rh-tokeefe rh-tokeefe commented Apr 6, 2026

IMPORTANT: Do Not Merge - To be merged by Docs Team Only

Merge to main and CP to release-1.10

Version(s):
1.10
Issue:
https://redhat.atlassian.net/browse/RHIDP-10993
Preview:
<!--- Add a link to the preview of the changed file(s). --->

@rhdh-bot
Copy link
Copy Markdown
Collaborator

rhdh-bot commented Apr 6, 2026

PR Build Results

Build passed -- 34/34 titles | 72s
Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-2020/


Content Quality Assessment

CQA Report

  • CQA-00a: Orphaned modules
  • CQA-00b: Directory structure
  • CQA-01: Vale AsciiDoc DITA compliance
  • CQA-02: Verify assembly structure
  • CQA-03: Verify content type metadata
  • CQA-04: Verify module templates
  • CQA-05: Verify required modular elements
  • CQA-06: Verify assemblies follow official template (one user story)
  • CQA-07: Verify TOC depth (max 3 levels)
  • CQA-08: Verify short description content quality
  • CQA-09: Verify short description format
  • CQA-10: Verify titles are brief, complete, and descriptive
  • CQA-11: Verify procedure prerequisites
  • CQA-12: Verify grammar and style (Vale)
  • CQA-13: Verify content matches declared type
  • CQA-14: Verify no broken links
  • CQA-15: Check redirects
  • CQA-16: Verify official product names
  • CQA-17: Verify legal disclaimers for preview features

Summary

Checks: 19 total, 19 pass, 0 fail

19 checks: 19 pass, 0 fail

Run node build/scripts/cqa/index.js --all --fix locally to review and auto-fix issues.


Updated 2026-05-20 16:07:17 UTC

@rh-tokeefe rh-tokeefe changed the title RHIDP-10933: [Doc] ServiceNow plugin: Allow integration without chang… RHIDP-10933: [Doc] ServiceNow plugin: Allow integration without changing ServiceNow infrastructure Apr 6, 2026
servicenow.com/service-id: <your-service-id>
----
+
metadata.annotations.servicenow.com/service-id:: Specifies the service identifier from your ServiceNow instance.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It would be nice to clarify this information better:

Annotation Format: metadata.annotations.servicenow.com/your-servicenow-table-field-name, where:

  • metadata.annotations.servicenow.com/ - annotation prefix used to determine that a ServiceNow tab should be displayed for catalog entities with this annotation
  • your-servicenow-table-field-name - name of the ServiceNow table column (service, company, category, etc.)

And user can specify few annotations to filter servicenow tickets.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

updated PR

@rh-tokeefe rh-tokeefe added the Technical review done ⛅ Any procedure has been succesfully tested label May 19, 2026
Comment on lines +28 to +30
`metadata.annotations.servicenow.com/service-id`:: Defines the custom annotation prefix that matches your `metadata.annotations` keys, which determines whether the portal workspace displays a *ServiceNow* tab for that catalog entity.

`servicenow.com/service-id`:: Specifies the unique identifier of the target item in your ServiceNow instance that links this catalog entity to its corresponding ServiceNow record.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
`metadata.annotations.servicenow.com/service-id`:: Defines the custom annotation prefix that matches your `metadata.annotations` keys, which determines whether the portal workspace displays a *ServiceNow* tab for that catalog entity.
`servicenow.com/service-id`:: Specifies the unique identifier of the target item in your ServiceNow instance that links this catalog entity to its corresponding ServiceNow record.
`servicenow.com/<field-name>`::
Annotation pattern for linking to ServiceNow records. Replace `<field-name>` with any ServiceNow table column name (such as `service-id`, `category`, `company`).
The `servicenow.com/` prefix enables the ServiceNow tab. You can add multiple annotations to filter by different fields.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Or something like that.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

done

@sonarqubecloud
Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Peer review needed 📖 Technical review done ⛅ Any procedure has been succesfully tested

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants