JSON Data Modeling Guide: updates

[mgroves]

Improvements, tweaks, fixes, corrections per our discussion in slack @ejscribner

Mainly scopes/collections, but also added mentions of Capella, changed the document key guidelines and 'type' guidelines, since those are no longer necessary with scopes/collections

[gemini-code-assist]

Summary of Changes

Hello @mgroves, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly updates the JSON Data Modeling Guide to incorporate modern Couchbase concepts, primarily focusing on the role of scopes and collections in data organization. It revises guidelines for document key design and the use of type fields, while also updating terminology and improving overall clarity.

Highlights

• Updated Data Modeling Guidance: The guide now heavily emphasizes the use of scopes and collections for organizing documents, aligning with modern Couchbase practices. This fundamentally changes previous recommendations regarding document key design and the use of type fields for grouping.
• Terminology Modernization: Throughout the documentation, "N1QL" has been consistently updated to "SQL++" and "Couchbase Server" to "Couchbase" for consistency with current product branding.
• Revised Document Key and Type Field Guidelines: The necessity of type fields within documents and prefixes in document keys for isolation is reduced, as collections now serve this purpose. The guide provides updated examples and rationale for key design.
• Capella Integration: Explicit mentions of Capella have been added to the technology metadata in several files, reflecting its importance in the Couchbase ecosystem.
• Documentation Refinements: Various minor text improvements, clarifications, and an updated link for Compare and Swap (CAS) documentation have been applied to enhance readability and accuracy.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request provides significant and valuable updates to the JSON Data Modeling Guide. The changes correctly reflect modern Couchbase practices by emphasizing scopes and collections over older methods like type fields and key prefixing for data isolation. The content is clearer, more accurate, and better aligned with current product features. I've included a few minor suggestions to fix typos and formatting issues to further improve the documentation's quality.

[ejscribner]

Looks good! 🙂 I think the gemini bot had a couple of grammar suggestions, some of which may not be correct, but the content looks great. Thanks so much!

[deniswsrosa]

this is great! we will review i asap.

[ejscribner]

Looks great, thanks @mgroves!