Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC-10139: Discussion of scopes and collections #2770

Merged
merged 2 commits into from Jun 23, 2022

Conversation

simon-dew
Copy link
Collaborator

Docs issue: DOC-10139

@simon-dew
Copy link
Collaborator Author

Complete discussion of scopes and collections is not appropriate for the buckets page, as these are described fully in their own page. I mentioned scopes and collections in the abstract, and linked to the scopes and collections page at the end.

@simon-dew simon-dew changed the title DOC-10139: Discussion scopes and collections DOC-10139: Discussion of scopes and collections Jun 18, 2022
Copy link
Contributor

@krugster krugster left a comment

Choose a reason for hiding this comment

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

I wonder if it might be good to take a bit more holistic view of how we are presenting these topics. There are multiple places for a reader to land on that all discuss buckets, scopes and collections in different ways and with varying levels of detail. Even with the best cross-linking, a reader is likely to find it very hard to know what they don't know and if they only read one of the multiple pieces of documentation on the topic, they won't be getting a complete picture.

For example:

I noticed that there's also no singe place where we explicitly connect the terms of bucket<->database, scope<->schema, collection<->table, document<->row (https://blog.couchbase.com/scopes-and-collections-for-modern-multi-tenant-applications-couchbase-7-0/)

@simon-dew
Copy link
Collaborator Author

These are great points @krugster . It's worth noting that for Elixir, we are aiming to overhaul the user documentation to improve the new starter experience, which will necessarily cover the introduction of key concepts like this. As such I'm going to merge this PR as a quick fix, but we'll take your comments on board as we plan the reworked documentation.

The nearest thing we have to a comparison with traditional relational database structures is here: Logical Hierarchy. It's hidden away in the Query section, and the terminology needs tightening up.

@simon-dew simon-dew merged commit 86112de into couchbase:release/7.1 Jun 23, 2022
@simon-dew simon-dew deleted the DOC-10139 branch June 23, 2022 23:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants