docs: add nosqldb for console#807
Open
madhavilosetty-intel wants to merge 1 commit into
Open
Conversation
5c5b363 to
3cf0aa9
Compare
There was a problem hiding this comment.
Pull request overview
Adds a new MongoDB/NoSQL documentation section under the Console reference, and updates Console configuration docs and MkDocs navigation to expose the new pages.
Changes:
- Add new Console → MongoDB docs (overview, quick start, collections/indexes, schema-change workflow, and extension guidance).
- Update Console configuration reference to document
DB_PROVIDERand clarify MongoDB-specific connection/pooling behavior. - Update MkDocs nav and adjust
.gitignoreto ignore generated MkDocs build output undersite/while keeping required versioning artifacts.
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Adds MongoDB section to the Console navigation. |
| docs/Reference/Console/MongoDB/overview.md | Introduces MongoDB backend overview and backend-selection notes. |
| docs/Reference/Console/MongoDB/quickStart.md | Adds Docker Compose-based quick start and validation steps. |
| docs/Reference/Console/MongoDB/collections.md | Documents MongoDB collections and unique indexes created at startup. |
| docs/Reference/Console/MongoDB/schemaChanges.md | Describes schema-change bookkeeping differences between SQL and MongoDB backends. |
| docs/Reference/Console/MongoDB/extending.md | Documents the pattern for adding additional NoSQL backends under internal/usecase/nosqldb/. |
| docs/Reference/Console/configuration.md | Adds DB_PROVIDER and clarifies DB_POOL_MAX/DB_URL semantics for MongoDB. |
| .gitignore | Ignores generated MkDocs output under site/ while allowing tracked index.html and versions.json. |
Comments suppressed due to low confidence (1)
docs/Reference/Console/MongoDB/collections.md:29
- This note claims cross-tenant uniqueness is enforced on
(profilename, domainsuffix), but the referenced SQL constraint (lower_name_suffix_idx) relates to the domain name/suffix fields (not a profile name). Update the described key fields to match the schema/constraint naming used elsewhere in the docs to avoid misleading readers about what is actually unique.
!!! note "Cross-tenant uniqueness on `domains`"
The `(profilename, domainsuffix)` index on `domains` omits `tenantid` by
design — it mirrors the SQL `lower_name_suffix_idx` constraint. Two
different tenants cannot register a domain with the same
`(profilename, domainsuffix)` pair, compared case-insensitively.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
3cf0aa9 to
16a3b95
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.
PR Checklist
What are you changing?
Anything the reviewer should know when reviewing this PR?