Skip to content

Conversation

@mstrivens
Copy link
Contributor

@mstrivens mstrivens commented Nov 14, 2025

Fixed the positioning of permissions warning callouts to ensure they're outside of tags while maintaining proper placement after permissions configuration sections.

Fixed 3 files that had warnings incorrectly placed inside tags:

  1. teamviewer-oauth.mdx - Moved warning after permissions configuration Steps section
  2. ukgpro.mdx - Moved warning after permissions configuration Steps section
  3. notion.mdx - Moved warning after permissions configuration Steps section

All warnings now follow the correct pattern:

  • Outside of tags ✅
  • Positioned after permissions configuration sections ✅
  • Maintain proper document structure ✅

Resolves #318

Generated with Claude Code


Summary by cubic

Standardized permissions warning callouts across 9 connection guides by moving them outside Step tags and placing them right after permissions configuration sections to improve readability and avoid layout issues (addresses #318).

  • Bug Fixes
    • Added or repositioned the warning callout after the permissions setup; removed it from inside Steps.
    • Updated guides: Notion, Personio, Personio (Custom Integrations), Staffology HR, UKG Pro, UKG Ready (OAuth Client Credentials), Workday, Google Workspace OAuth, TeamViewer OAuth.

Written for commit 60d9ae7. Summary will update automatically on new commits.

claude bot and others added 2 commits November 13, 2025 15:05
- Add permissions warnings to 8 files with detailed permission configurations
- Position warnings consistently after permissions configuration sections
- Ensures users are aware that permission requirements may change
- Files updated: workday, personio, ukgready-oauth-client-credentials,
  notion, ukgpro, staffologyhr, googleworkspace-oauth,
  personio-custom-integrations, teamviewer-oauth

Co-authored-by: Max Strivens <[email protected]>
Move warning callouts outside of Step tags but keep them within document structure after permissions configuration sections.

Fixed in:
- teamviewer-oauth.mdx: Moved warning after permissions configuration Steps
- ukgpro.mdx: Moved warning after permissions configuration Steps
- notion.mdx: Moved warning after permissions configuration Steps

Resolves #318

Co-authored-by: Max Strivens <[email protected]>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR fixes the positioning of permissions warning callouts across 9 documentation files to ensure they are properly placed outside of <Step> tags. The changes move warning callouts to appear after their respective permissions configuration sections while maintaining proper document structure.

  • Repositioned warning callouts to be outside of <Step> tags across 9 integration guide files
  • Ensured warnings appear after permissions configuration sections
  • Maintained consistent placement pattern throughout documentation

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
connection-guides/iam/teamviewer-oauth.mdx Moved warning outside Steps block after permissions configuration
connection-guides/iam/googleworkspace-oauth.mdx Added warning after OAuth consent and scope configuration Steps
connection-guides/hris/workday.mdx Added warning after security group permissions Steps
connection-guides/hris/ukgready-oauth-client-credentials.mdx Moved warning outside Accordion within permissions configuration
connection-guides/hris/ukgpro.mdx Added warning after service account permissions Steps
connection-guides/hris/staffologyhr.mdx Added warning after API user creation Steps and Note
connection-guides/hris/personio.mdx Added warning between Steps blocks in API credentials generation section
connection-guides/hris/personio-custom-integrations.mdx Added warning after integration creation Steps
connection-guides/documents/notion.mdx Added warning after API integration configuration Steps
Comments suppressed due to low confidence (1)

connection-guides/hris/personio.mdx:89

  • There are two steps with similar purposes both titled "Copy API credentials" (lines 76 and 87). Step 76 describes viewing the credentials with copy buttons, while Step 87 instructs to copy them to a safe place and click "Finish". These appear to be duplicative and could confuse users.

Consider consolidating these into a single step that includes all necessary actions: viewing the generated credentials, copying them using the provided buttons, storing them securely, and clicking "Finish".

  <Step title="Copy API credentials">
    Once the integration is created, you'll see your API credentials displayed:
    - **Client ID**: A unique identifier for your integration
    - **API Secret**: A secret key for authentication
    
    Copy both values to a secure location. You can use the "Copy" buttons provided.
    <Frame>
      <img className='rounded-md' style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="API Credentials Generated" src="/images/personio/api-credentials-generated.png" />
    </Frame>
  </Step>

  <Step title="Copy API credentials">
    Copy your API credentials – client id and client secret to a safe place, then click "Finish".
  </Step>

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@mstrivens mstrivens changed the title docs: Fix positioning of permissions warning callouts docs: Add permissions callout to hub docs Nov 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation Update

2 participants