Updating ServiceNow plugin setup documentation#9030
Conversation
The way the documentation currently describes searching for ` x_830655_mm_std_servicenow_for_mattermost_notifications_auth_list.` doesn't work in the latest ServiceNow releases. The most straightforward way of accessing it now is straight trough the URL, and it is also the safest as it's backwards compatible all the way to the oldest still-supported ServiceNow releases (Utah / Vancouver) all the way through the latest (Zurich).
📝 WalkthroughWalkthroughA single line in the ServiceNow integration guide was updated to replace menu-based navigation instructions with a direct URL for accessing the auth table list view during setup. ChangesServiceNow Setup Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
source/integrations-guide/servicenow.rst (1)
52-52: ⚡ Quick winNormalize placeholder style for consistency with earlier instructions.
The placeholder on line 52 uses lowercase
<your-instance>, but the earlier placeholder on line 19 uses uppercase<YOUR-MATTERMOST-URL>. For consistency across the documentation, both placeholders should use the same casing style.✏️ Proposed fix for placeholder consistency
-2. In your ServiceNow instance, open the auth table's list view by navigating directly to ``https://<your-instance>.service-now.com/x_830655_mm_std_servicenow_for_mattermost_notifications_auth_list.do``, replacing <your-instance> with your ServiceNow instance subdomain. +2. In your ServiceNow instance, open the auth table's list view by navigating directly to ``https://<YOUR-INSTANCE>.service-now.com/x_830655_mm_std_servicenow_for_mattermost_notifications_auth_list.do``, replacing <YOUR-INSTANCE> with your ServiceNow instance subdomain.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@source/integrations-guide/servicenow.rst` at line 52, The placeholder "<your-instance>" in the ServiceNow URL example should use the same uppercase placeholder style as earlier docs; update the text that contains "https://<your-instance>.service-now.com/..." to use "<YOUR-INSTANCE>" instead (i.e., "https://<YOUR-INSTANCE>.service-now.com/...") so the placeholder casing matches the earlier "<YOUR-MATTERMOST-URL>" style.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@source/integrations-guide/servicenow.rst`:
- Line 52: The placeholder "<your-instance>" in the ServiceNow URL example
should use the same uppercase placeholder style as earlier docs; update the text
that contains "https://<your-instance>.service-now.com/..." to use
"<YOUR-INSTANCE>" instead (i.e., "https://<YOUR-INSTANCE>.service-now.com/...")
so the placeholder casing matches the earlier "<YOUR-MATTERMOST-URL>" style.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 50324be7-6858-431c-a34d-2d6a5219bea2
📒 Files selected for processing (1)
source/integrations-guide/servicenow.rst
Summary
When setting up the plugin I've found that with changes made to the UI in more recent ServiceNow releases, searching for the auth table list view, the way the documentation currently describes, returns no results.
The quickest way to access it now is directly via the URL. It is also the safest option as it's backwards compatible and will work on the oldest still-supported ServiceNow releases (Utah / Vancouver) all the way through the latest (Zurich).