Skip to content

[AV-105759] Initial changes for Columnar/Analytics Service rename #41

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.

Sign up for GitHub

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

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

[AV-105759] Initial changes for Columnar/Analytics Service rename #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ValeStyles/Couchbase/Terminology.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@ swap:
adaptor: adapter
ad-hoc: adhoc|ad hoc
afterward: afterwards
Analytics Service: Capella Analytics|Enterprise Analytics
(?:automatic-schema discovery|automatic-schema-discovery)': automatic schema discovery
'(?:auto sharding|autosharding)': auto-sharding
availability-zone: Availability Zone
'(?:blacklist|blocklist|deny-list)': Denylist
cheatsheet: cheat sheet
check point: checkpoint
'(?:code base|code-base)': codebase
'(?:Columnar|Capella Columnar)': Capella Analytics
'(?:compare-and-swap|compare-and swap|compare and-swap)': Compare and Swap
'(?:cross-datacenter replication|cross data center replication|cross-datacenter-replication)': cross datacenter replication
'(?:data center|data-center)': datacenter
Expand Down
3 changes: 2 additions & 1 deletion ValeStyles/config/vocabularies/Couchbase/accept.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ bootstrap
CAS
[Cc]allout
[Cc]allouts
Capella Analytics
cbbackupmgr
cbcollect
cbtransfer
Capella
Compare and Swap
CentOS
Cluster Manager
Columnar
ConfigProviderBase
Confluent Cloud
cloud\.couchbase
Expand Down Expand Up @@ -58,6 +58,7 @@ Dockerfile
Elasticsearch
EMEA
Engagement Database
Enterprise Analytics
ETL
Event-Condition-Action model
FAQ
Expand Down
2 changes: 2 additions & 0 deletions ValeStyles/config/vocabularies/Couchbase/reject.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Analytics Service
and\/or
back end
(C\+\+)
Columnar
Couchbase managed cloud
data link
data provider
Expand Down
19 changes: 11 additions & 8 deletions styleguide/modules/ROOT/pages/word-list.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ For terms not covered here, see the https://developers.google.com/style/word-lis
| Amazon MSK Kafka pipeline | Do not expand MSK when referring to a specific pipeline. Capitalize as shown. Do not capitalize "pipeline."
| Amazon S3 | Make sure to capitalize Amazon and the S in "S3."
| [[amber]]amber | If you need to refer to traffic lights or a health warning color, use amber, not <<yellow,yellow>>.
| Analytics Service | When referring to Couchbase Services, use title case.
| Analytics Service | Legacy product name. Use Capella Analytics or Enterprise Analytics, instead, depending on the product.
| APAC | Write as a proper acronym. For more information, see xref:capitalization.adoc[].
| API | Application Programming Interface. Don't write out for first use on a page.
| app / application | Use app for mobile applications. Use application for client software, such as Couchbase Server.
Expand Down Expand Up @@ -84,6 +84,7 @@ For terms not covered here, see the https://developers.google.com/style/word-lis
| Term | Notes

| {cpp} | Antora will sometimes interpret ++ as markup instructions, and leave only *C* on the page. Follow https://asciidoctor.org/docs/user-manual/#charref-attributes[asciidoctor recommendations] and use \{cpp}.
| Capella Analytics | Proper product name for analytics on Capella. Write as written. Do not use Columnar. Refer to specific instances of Capella Analytics as <<cluster,clusters>>.
| Compare and Swap (CAS) | Write out for the first use on a page. Capitalize as a proper product name.
| `cbbackupmgr` | Follow the capitalization and spelling set in the code.
| `cbcollect` | Follow the capitalization and spelling set in the code.
Expand All @@ -96,20 +97,21 @@ For terms not covered here, see the https://developers.google.com/style/word-lis
| cloud | Write in lowercase unless as part of a product name.
| cloud native | Use cloud native as the noun. Use cloud-native as the adjective.
| cloud service provider (CSP) | Write in all lowercase. Make sure to include the acronym in brackets. Use the acronym for subsequent uses on a page.
| [[cluster]]cluster | Preferred term, if referring to Couchbase Server or Couchbase Capella operational or Columnar. We no longer use <<database,database>>.
| [[cluster]]cluster | Preferred term, if referring to Couchbase Server or Couchbase Capella operational or Capella Analytics. We no longer use <<database,database>>.
| Cluster Manager | Follow the official capitalization as set by Couchbase. For more information, see xref:capitalization.adoc[].
| codebase | Write as one word. Don't add a hyphen.
| collection | Do not capitalize. Do not capitalize even when referring to a remote, external, or standalone collection.
| collection | Do not capitalize. Do not capitalize even when referring to a remote, external, or standalone collection.
| Columnar | Old product name for Capella Analytics. Do not use.
| command line | Use command line as the noun. Use command-line as the adjective.
| config(s) | Don't use. Use configuration as the noun. Use configure as the verb.
| Confluent Cloud | Capitalize as a proper noun.
| Confluent Cloud Kafka pipeline | Capitalize Confluent, Cloud, and Kafka as proper nouns. Do not capitalize "pipeline."
| `ConfigProviderBase` | Follow the capitalization and spelling set in the code.
| Couchbase | Follow the official capitalization as set by Couchbase. For more information, see xref:capitalization.adoc[].
| Couchbase Autonomous Operator (CAO) | Follow the official capitalization as set by Couchbase. For more information, see xref:capitalization.adoc[].
| Couchbase Capella | "Couchbase Cloud" or "Couchbase Managed Cloud" in legacy documentation. Use "operational cluster" if you need to specify which type of Capella instance, as opposed to Columnar. Write as *Couchbase Capella* + *operational cluster* for the first use on a page. Follow the official capitalization as set by Couchbase. For more information, see xref:capitalization.adoc[].
| Couchbase Capella | "Couchbase Cloud" or "Couchbase Managed Cloud" in legacy documentation. Use "operational cluster" if you need to specify which type of Capella instance, as opposed to Capella Analytics. Write as *Couchbase Capella* + *operational cluster* for the first use on a page. Follow the official capitalization as set by Couchbase. For more information, see xref:capitalization.adoc[].
| Couchbase Cluster Connection Protocol (CCCP) | Write out for the first use on a page. Follow the official capitalization as set by Couchbase. For more information, see xref:capitalization.adoc[].
| Couchbase Columnar | Write as *Capella Columnar Services* for the first use on a page. Use just *Columnar* for any subsequent uses. Refer to specific instances of Columnar as <<cluster,clusters>>, as opposed to the Couchbase Capella operational clusters.
| Couchbase Columnar | Old product name for Capella Analytics. Do not use.
| (the) Couchbase Data Platform | Write as data platform if not preceded by *Couchbase*. Follow the official capitalization as set by Couchbase. For more information, see xref:capitalization.adoc[].
| Couchbase Eventing Service | When referring to Couchbase Services, use title case.
| Couchbase Functions | Follow the official capitalization as set by Couchbase. For more information, see xref:capitalization.adoc[].
Expand All @@ -129,7 +131,7 @@ For terms not covered here, see the https://developers.google.com/style/word-lis
|===
| Term | Notes

| [[database]]database | Do not capitalize when referring to a database in Capella Columnar. Do not use to refer to Capella operational <<clusters,clusters>>.
| [[database]]database | Do not capitalize when referring to a database in Capella Analytics. Do not use to refer to Capella operational <<clusters,clusters>>.
| Database Change Protocol (DCP) | Write out for the first use on a page.
| data center | Write as two words. Don't add a hyphen.
| datacenter replication | Write as two words. Don't add a hyphen.
Expand Down Expand Up @@ -177,7 +179,8 @@ For terms not covered here, see the https://developers.google.com/style/word-lis
| end user | Use end user as the noun. Use end-user as the adjective.
| Engagement Database | Capitalize as a proper product name.
| ensure | Don't use. Use make sure, instead.
| e-payment | Add the hyphen. Don't capitalize.
| Enterprise Analytics | Product name for the on-premise Couchbase Analytics solution. Do not use Analytics Service or Columnar.
| ePayment | Write as shown. Do not hyphenate.
| error-free | Add the hyphen.
| etc. | Don't use Latin abbreviations. Use *and so on*, instead.
| Event-Condition-Action model | Add the hyphens. Capitalize Event, Condition, and Action.
Expand Down Expand Up @@ -384,7 +387,7 @@ a|
| on-premises | Use on premises as the noun. Use on-premises as the adjective.
| on-site/off-site | Add a hyphen.
| open source | Don't add a hyphen.
| operational cluster | Use when referring to a cluster on Couchbase Capella operational, as opposed to a Capella Columnar cluster.
| operational cluster | Use when referring to a cluster on Couchbase Capella operational, as opposed to a Capella Analytics cluster.
| opt-out | Add the hyphen.
| Oxford comma | See xref:commas.adoc[].
| `optimisticReplicationThreshold` | Use camelcase as set in the code.
Expand Down
Loading