Skip to content

docs(km): apply KM fixes and expand abapcloud destination guide#139

Merged
longieirl merged 5 commits intomainfrom
docs/abapcloud-km-fixes
Apr 16, 2026
Merged

docs(km): apply KM fixes and expand abapcloud destination guide#139
longieirl merged 5 commits intomainfrom
docs/abapcloud-km-fixes

Conversation

@longieirl
Copy link
Copy Markdown
Member

Summary

  • Fixes all markdownlint issues in misc/abapcloud/README.md (multiple H1s, bare code fence, trailing spaces, missing blank lines)
  • Applies KM standards: H4 sentence case, viausing, a SAPan SAP, Please noteNote that, missing comma, code fence language tag
  • Expands the cross-account destination section with a new Key Notes from the Tutorial subsection covering:
    • Connectivity overview
    • Destination configuration with OAuth2UserTokenExchange and SAMLAssertion example JSON (obfuscated)
    • Cross-subaccount requirements including SAML trust certificate export/import via Communication Systems
    • Roles and authorizations
    • Service discovery (V2/V4 catalog endpoints)
    • Common failure patterns table (HTTP 401, HTTP 500, empty catalog)

Test plan

  • npx markdownlint-cli misc/abapcloud/README.md passes with no output
  • All destination examples use obfuscated placeholder values
  • KM heading case: H1–H3 title case, H4+ sentence case
  • No via usage remains; no a SAP article errors remain

- Fix markdown lint issues: multiple H1s, bare code fence, trailing space,
  missing blank lines around list and code fence
- Apply KM rules: H4 headings to sentence case, 'via' → 'using',
  'a SAP' → 'an SAP', 'Please note' → 'Note that', missing comma before 'which'
- Add code fence language tag (text) to WebIDEUsage snippet
- Fix H2 verb parallelism: 'Deploy' → 'Deploying It'
- Add Key Notes from the Tutorial section covering connectivity overview,
  destination configuration (with OAuth2UserTokenExchange and SAMLAssertion
  examples), cross-subaccount requirements including SAML trust certificate
  setup, roles and authorizations, service discovery, and common failure patterns
@longieirl longieirl self-assigned this Apr 16, 2026
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 16, 2026

🔗 Link Check Results

The link checker has completed. This is an optional check and will not block the PR.

View workflow run for details

If broken links were found, please review them at your convenience.


Last updated: Run #178 at 2026-04-15T13:44:04Z

- Clarify connectivity overview: odata_abap usage, URL must be base host only,
  BAS Cloud Foundry org/space prerequisite
- Add WebIDEEnabled and HTML5.DynamicDestination as required destination properties
- Add Environment Check as primary troubleshooting validation step with steps
  sourced from misc/destinations README
- Split Troubleshooting into two subsections: Environment Check and connectivity trace
- Tighten service discovery description to reference odata_abap behavior explicitly
@longieirl longieirl merged commit f3aa4d0 into main Apr 16, 2026
4 checks passed
@github-actions github-actions bot deleted the docs/abapcloud-km-fixes branch April 16, 2026 08:46
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.

1 participant