Add documentation improvement plan doc#240
Open
hossain-rayhan wants to merge 2 commits intodocumentdb:mainfrom
Open
Add documentation improvement plan doc#240hossain-rayhan wants to merge 2 commits intodocumentdb:mainfrom
hossain-rayhan wants to merge 2 commits intodocumentdb:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a comprehensive documentation improvement plan that outlines a structured approach to enhance the DocumentDB Kubernetes Operator documentation from its current preview state to production-ready documentation.
Changes:
- Adds a detailed 9-phase documentation improvement plan with 37 tasks covering all aspects of operator documentation
- Proposes a new documentation structure organized into logical categories (getting-started, architecture, configuration, operations, high-availability, disaster-recovery, security, monitoring, troubleshooting, and reference)
- Establishes documentation guidelines that separate executable scripts (in documentdb-playground/) from documentation content
xgerman
reviewed
Feb 13, 2026
Collaborator
xgerman
left a comment
xgerman
left a comment
There was a problem hiding this comment.
As part of this work:
- We will need a documentation agent
- Where are we putting fleet and kamado?
- How do we do "How to get help?" on the main page or a doc page
- It's light on How to contrinute? File bugs, etc? But that might be ok
alaye-ms
reviewed
Feb 13, 2026
abhirockzz
reviewed
Feb 16, 2026
abhirockzz
reviewed
Feb 16, 2026
abhirockzz
reviewed
Feb 16, 2026
abhirockzz
reviewed
Feb 16, 2026
abhirockzz
reviewed
Feb 16, 2026
added 2 commits
February 19, 2026 09:26
Signed-off-by: Rayhan Hossain <rhossain@microsoft.com>
Signed-off-by: Rayhan Hossain <rhossain@microsoft.com>
hossain-rayhan
force-pushed
the
rayhan/doc-gaps
branch
from
42b6cbc to
5b57626
Compare
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
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.
No description provided.