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

[AV-60739] Attributes for Day 0 Docs #767

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sarahlwelton
Copy link
Contributor

Adding necessary {db} and {cptl-db} attributes to playbooks for building docs after Day 0 updates.

Will make the future transition onto "operational database" much easier, if that ends up being the final decision.

@@ -183,6 +183,8 @@ asciidoc:
sqlpp: SQL++
sqlpp_url: https://www.couchbase.com/products/n1ql
cbpp: Couchbase++
db: cluster
cptl-db: Cluster
Copy link
Collaborator

Choose a reason for hiding this comment

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

As someone who has enjoyed figuring out what attributes like {sgw-te} and {cblFrmWk} in Mobile mean, I'm excited about everyone else getting the opportunity to participate in the fun!

(Don't mean to snark, I've perpetrated enough of these myself... anyway, seeing it in a PR makes me wonder if we should try to do something about it and maybe come up with some best practices ongoing.)

e.g. What does cptl mean? Can we spell it out in full?
Or is it worth adding YAML comments, like e.g.:

db: cluster # the name of a "database-like-thing"

Copy link
Collaborator

Choose a reason for hiding this comment

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

Could be listed in the README?

(I'm in the process of doing just that for SDK Docs' own growing list of attributes)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was trying to keep it short for the sake of easy typing in running doc.

If we'd rather spell it out for explicitness, I'm okay with that.

Copy link
Contributor

Choose a reason for hiding this comment

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

an inline comment would be wonderful from my PoV

@sarahlwelton sarahlwelton marked this pull request as ready for review May 30, 2024 16:36
@lamagnifica
Copy link
Contributor

@sarahlwelton do we need to start with tokens for both database and cluster? or product-specific tokens?
Capella uses cluster in the APIs and database in the UI to mean the same object.
Capella columnar services uses cluster for, essentially, the same object again, in both the API and the UI.

Rumor is that eventually, in Capella database will be replaced with operational database, but the API will continue to use cluster.
In sum, "cluster" is a valid term, and "database" is a valid term, and the only potential change coming is "database" to "operational database".
I think that adding only a single token now for cluster, and naming it {db}, is going to be problematic.

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.

None yet

4 participants