docs: revise terminology, slim public docs, relocate CPDM-specific content#9
Merged
avsrivastava merged 1 commit intoMay 19, 2026
Conversation
…ntent - Replace 'customer' with 'data consumer' (and similar) across public docs to reflect the audience of this Microsoft-owned public repo (operators/data consumers, not Azure customers). - Trim docs/architecture.md and docs/faq.md to generic starter-kit content; remove deep operator-specific guidance that belongs in the internal platform repo. - Trim docs/consumer-ingestion-guide.md to the manifest/index/checkpoint contracts and drop references to internal pipeline names (KustoOrchestratorPipeline, etc.). - Extract the 'Enhance the Starter Kit' section into new docs/extending-the-starter-kit.md (Fabric/SQL/Snowflake substitution patterns). - Delete docs/implementation-checklist.md from the public repo; it will be relocated to the internal platform repo.
avsrivastava
approved these changes
May 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Implements the documentation follow-ups agreed in the May 18 sync.
Terminology
README.md.Slim public docs
docs/architecture.mdrewritten: trimmed prescriptive operator content; kept high-level overview, components, deployment flow, security boundaries.docs/faq.mdrewritten: cut from 255 to ~60 lines; kept General / Deployment / Security / Contributing essentials.docs/consumer-ingestion-guide.mdrewritten: kept only the manifest, index-file, and checkpointing contracts. Removed references to internal platform pipeline names (KustoOrchestratorPipeline,KustoIngestionPipeline, etc.) and broken../resources/...links.Relocate / split
docs/extending-the-starter-kit.mdextracted from the old "Guide 2: Enhance the Starter Kit" - keeps the Fabric / SQL / Snowflake substitution patterns under a clearer name.docs/implementation-checklist.md- internal operator checklist; will be relocated to the CPDM platform repo.Terminology pass beyond
docs/CONTRIBUTING.md,SECURITY.md,SUPPORT.mdfor consistency.CHANGELOG
Out of scope
Review
Per meeting agreement: Anand and Ashish to review/approve.
Diff: 10 files changed, +256 / -833.