Skip to content

docs: add Multi-tenancy section to all module user guides#243

Merged
cassiofariasmachado merged 6 commits into
mainfrom
docs/add-multi-tenancy-section-to-all-modules
Jul 22, 2026
Merged

docs: add Multi-tenancy section to all module user guides#243
cassiofariasmachado merged 6 commits into
mainfrom
docs/add-multi-tenancy-section-to-all-modules

Conversation

@cassiofariasmachado

@cassiofariasmachado cassiofariasmachado commented Jul 22, 2026

Copy link
Copy Markdown
Member

Disclaimer: Do not include SAP-internal or customer-specific information in this PR (e.g. internal system URLs, customer names, tenant IDs, or confidential configurations). This is a public repository.

Description

Add a consistent ## Multi-tenancy section to every module user guide in the SDK, documenting whether subscriber token exchange is supported, which authentication mechanism is used, how to configure it, and links to SAP Help Portal pages for further reading.

The section follows a standard template:

  • Supported: Yes / No / Not yet / N/A
  • Authentication: XSUAA / IAS / N/A
  • How to use: explanation or code example
  • Further reading: links

Also update the project review-pr skill with two new review criteria to enforce this going forward:

  • D6: Multi-tenancy support — design-level check (⚠️ nice-to-have) prompting reviewers to consider whether new service modules should expose subscriber routing
  • E2a: Multi-tenancy documentation — docs check (❌ for new service modules without a section)

Related Issue

Closes #<issue_number>

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Code refactoring
  • Dependency update

How to Test

  1. Browse any updated user-guide.md and verify a ## Multi-tenancy section is present with all four fields filled
  2. Run /review-pr on this PR and verify D6 and E2a appear in the output

Checklist

  • I have read the Contributing Guidelines
  • I have verified that my changes solve the issue
  • All tests pass locally
  • I have verified that my code follows the Code Guidelines
  • I have updated documentation (if applicable)
  • My code does not contain sensitive information (credentials, tokens, etc.)
  • I have followed Conventional Commits for commit messages

Add a consistent ## Multi-tenancy section to every module user guide,
documenting whether subscriber token exchange is supported, which auth
mechanism is used, how to configure it, and links to further reading.

Also update the project review-pr skill with two new criteria:
- D6: Multi-tenancy support (design check, nice-to-have)
- E2a: Multi-tenancy documentation (docs check, required for new modules)

Modules updated: destination, agent_memory, dms, print, objectstore,
agentgateway, aicore, adms, core/auditlog, core/auditlog_ng,
core/data_anonymization, core/telemetry, core/secret_resolver
@cassiofariasmachado
cassiofariasmachado requested a review from a team as a code owner July 22, 2026 15:51
Comment thread .claude/skills/review-pr/SKILL.md
Comment thread src/sap_cloud_sdk/agentgateway/user-guide.md Outdated
Comment thread src/sap_cloud_sdk/agentgateway/user-guide.md
Comment thread src/sap_cloud_sdk/aicore/user-guide.md
@cassiofariasmachado
cassiofariasmachado force-pushed the docs/add-multi-tenancy-section-to-all-modules branch from ed92735 to 210e31a Compare July 22, 2026 18:18
@cassiofariasmachado
cassiofariasmachado merged commit cf61b6b into main Jul 22, 2026
9 of 10 checks passed
@cassiofariasmachado
cassiofariasmachado deleted the docs/add-multi-tenancy-section-to-all-modules branch July 22, 2026 19:00
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.

2 participants