Skip to content

docs: add nosqldb for console#807

Open
madhavilosetty-intel wants to merge 1 commit into
mainfrom
mongodb
Open

docs: add nosqldb for console#807
madhavilosetty-intel wants to merge 1 commit into
mainfrom
mongodb

Conversation

@madhavilosetty-intel
Copy link
Copy Markdown
Contributor

PR Checklist

What are you changing?

Anything the reviewer should know when reviewing this PR?

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_PROVIDER and clarify MongoDB-specific connection/pooling behavior.
  • Update MkDocs nav and adjust .gitignore to ignore generated MkDocs build output under site/ 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.

Comment thread docs/Reference/Console/MongoDB/collections.md
Comment thread docs/Reference/Console/MongoDB/extending.md
Comment thread docs/Reference/Console/MongoDB/schemaChanges.md
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