Skip to content

Commit 668df92

Browse files
authored
Updated Ruby on Rails docs (#22)
* added ruby on rails docs * updated ruby docs * fixed ruby docs * Add 'ruby' and 'Rails' to sdk_languages and tags * Update tags in quickstart-ruby-on-rails.md * Update tags in test-markdown-frontmatter.js * Update tags in test-markdown-frontmatter.js * added images * added ruby couchbase ORM markdown files * renamed files * chore: update tags in test-markdown-frontmatter.js * chore: Update ruby tutorial and added orm tutorial * Update Ruby on Rails quickstart tutorial to reflect port change from 8080 to 3000 for local application and Swagger documentation access. * Update Ruby Couchbase ORM quickstart tutorial to correct directory name, install additional gem, and reflect port change to 3000 for application and Swagger documentation access. * feedback comments * Refactor Ruby Couchbase ORM quickstart tutorial for clarity and accuracy. Removed redundant gem installation instructions, updated image paths for consistency, and improved explanations for connection handling and CRUD operations. * Refactor Couchbase Capella connection instructions in Java tutorial for clarity. Removed redundant notes, corrected typos, and improved formatting for better readability. * Add health check endpoint to Ruby Couchbase ORM and Rails tutorials - Introduced a health check endpoint (`GET /api/v1/health`) for monitoring application health and Couchbase connectivity. - Updated documentation with example responses for healthy and unhealthy states. - Enhanced test structure section to clarify integration and Swagger documentation tests. - Organized API tests by entity, including new hotel-related specs. - Improved clarity and consistency in the tutorial content.
1 parent 2434439 commit 668df92

8 files changed

Lines changed: 1499 additions & 23 deletions

File tree

test/test-markdown-frontmatter.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@ const path = require('path')
33
const yaml = require('js-yaml')
44
const chalk = require('chalk')
55

6-
const sdk_languages = ['nodejs','scala','python','swift','csharp','objective-c','android-java','any','java','kotlin','dart','golang','php','c++'];
6+
// accepted data field values
7+
const sdk_languages = ['nodejs', 'scala', 'python', 'swift', 'csharp', 'objective-c', 'android-java', 'any', 'java', 'kotlin', 'dart', 'golang', 'ruby', 'php', 'c++']
78

8-
const tags = ['Ottoman', 'Ktor', 'REST API', 'Express', 'Flask', 'TLS', 'Configuration', 'Next.js', 'iOS', 'Xcode', '.NET', 'Xamarin', 'Authentication', 'OpenID', 'Keycloak', 'Android', 'P2P', 'UIKit', 'Installation', 'Spring Boot', 'Spring Data', 'Transactions', 'SQL++ (N1QL)', 'Optimization', 'Community Edition', 'Docker', 'Data Modeling', 'Metadata', 'Best Practices', 'Data Ingestion', 'Kafka', 'Airbyte', 'Support', 'Customer', 'Prometheus', 'Monitoring', 'Observability', 'Metrics', 'Query Workbench', 'ASP.NET', 'linq', 'DBaaS', 'App Services', 'Flutter', 'Gin Gonic', 'FastAPI', 'Laravel', 'LangChain', 'OpenAI', 'Streamlit', 'Google Gemini', 'Nvidia NIM', 'LLama3', 'AWS', 'Artificial Intelligence', 'Cohere', 'Jina AI', 'Mistral AI', 'Ragas', 'Haystack', 'LangGraph', 'Amazon Bedrock', 'CrewAI', 'PydanticAI', 'C++', 'C++ SDK', 'smolagents', 'Ag2', 'Autogen', 'Couchbase Edge Server', 'Deepseek', 'OpenRouter', 'mastra', 'Looker Studio', 'Google Data Studio', 'Connector', 'Couchbase Columnar', 'TAVs', 'Custom Queries', 'Data API', 'FTS', 'GSI', 'Hugging Face', 'LlamaIndex', 'GraphQL', 'Semantic Kernel', 'Hyperscale Vector Index', 'Composite Vector Index', 'Search Vector Index']
9+
const tags = ['Ottoman', 'Ktor', 'REST API', 'Express', 'Flask', 'TLS', 'Configuration', 'Next.js', 'iOS', 'Xcode', '.NET', 'Xamarin', 'Authentication', 'OpenID', 'Keycloak', 'Android', 'P2P', 'UIKit', 'Installation', 'Spring Boot', 'Spring Data', 'Transactions', 'SQL++ (N1QL)', 'Optimization', 'Community Edition', 'Docker', 'Data Modeling', 'Metadata', 'Best Practices', 'Data Ingestion', 'Kafka', 'Airbyte', 'Support', 'Customer', 'Prometheus', 'Monitoring', 'Observability', 'Metrics', 'Query Workbench', 'ASP.NET', 'linq', 'DBaaS', 'App Services', 'Flutter', 'Gin Gonic', 'FastAPI', 'Rails', 'Couchbase ORM', 'Laravel', 'LangChain', 'OpenAI', 'Streamlit', 'Google Gemini', 'Nvidia NIM', 'LLama3', 'AWS', 'Artificial Intelligence', 'Cohere', 'Jina AI', 'Mistral AI', 'Ragas', 'Haystack', 'LangGraph', 'Amazon Bedrock', 'CrewAI', 'PydanticAI', 'C++', 'C++ SDK', 'smolagents', 'Ag2', 'Autogen', 'Couchbase Edge Server', 'Deepseek', 'OpenRouter', 'mastra', 'Looker Studio', 'Google Data Studio', 'Connector', 'Couchbase Columnar', 'TAVs', 'Custom Queries', 'Data API', 'FTS', 'GSI', 'Hugging Face', 'LlamaIndex', 'GraphQL', 'Semantic Kernel', 'Hyperscale Vector Index', 'Composite Vector Index', 'Search Vector Index']
910

1011
const technologies = ['connectors', 'kv', 'query', 'capella', 'server', 'index', 'mobile', 'fts', 'sync gateway', 'eventing', 'analytics', 'udf', 'vector search', 'react', 'edge-server', 'app-services', 'hyperscale vector index', 'composite vector index']
1112

tutorial/markdown/java/transactions.md

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -158,26 +158,10 @@ spring.couchbase.bucket.password=password
158158
> **_NOTE:_** Couchbase Capella clusters are using Transport Security Layer (TLS) cryptographic protocol to secure traffic between the cluster and client applications.
159159
> For simplicity, we will forego certificate validation step in this tutorial.
160160
> It is highly recommended to always verify your cluster's certificate on production environments.
161-
162-
<<<<<<< HEAD
163-
> **_NOTE:_** Couchbase Capepella clusters are using Transport Security Layer (TLS) cryptographic protocol to secure traffic between the cluster and client applications.
164-
Every Capella cluster comes with its own self-signed TLS certificate.
165-
This certificate can be used by client applications to verify the identity of the server and prevent attackers from intercepting database traffic.
166-
It is highly recommended to always verify your cluster's certificate on production environments.
167-
Please refer to "Full Example / Couchbase Capella Sample" and "Cloud Connections" sections of [Install and Start Using the Java SDK with Couchbase Server](https://docs.couchbase.com/java-sdk/current/hello-world/start-using-sdk.html#full-example) for information on how to validate cluster certificates.
168-
169-
To connect to Capella, use `couchbases://` connection protocol and add `?tls=no_verify` to the connection string:
170-
171-
```ini
172-
spring.couchbase.bootstrap-hosts=couchbases://cb.jncm2s9gv4ealbm.cloud.couchbase.com?ssl=no_veriify
173-
```
174-
175-
Save the file and start the sample application by running the following command in the root folder of the project:
176-
=======
177161
> Please refer to "Full Example / Couchbase Capella Sample" and "Cloud Connections" sections of [Install and Start Using the Java SDK with Couchbase Server](https://docs.couchbase.com/java-sdk/current/hello-world/start-using-sdk.html#full-example) for information on how to validate cluster certificates.
178162
179163

180-
To confiure Capella connections, use a `ClusterEnvironment` with enabled TLS security:
164+
To configure Capella connections, use a `ClusterEnvironment` with enabled TLS security:
181165

182166
```java
183167
@Bean
@@ -191,7 +175,7 @@ To confiure Capella connections, use a `ClusterEnvironment` with enabled TLS sec
191175

192176
public ClusterEnvironment getClusterEnvironment() {
193177
ClusterEnvironment.Builder environmentBuilder = ClusterEnvironment.builder();
194-
178+
195179
SecurityConfig.Builder securityConfig = SecurityConfig.enableTls(true)
196180
.trustManagerFactory(InsecureTrustManagerFactory.INSTANCE);
197181
environmentBuilder.securityConfig(securityConfig);
@@ -200,15 +184,14 @@ To confiure Capella connections, use a `ClusterEnvironment` with enabled TLS sec
200184
}
201185
```
202186

203-
Another alternative is to use`couchbases://` connection protocol and add `?ssl=no_verify` to the connection string:
187+
Another alternative is to use `couchbases://` connection protocol and add `?ssl=no_verify` to the connection string:
204188
```ini
205189
spring.couchbase.bootstrap-hosts=couchbases://cb.jnym5s9gv4ealbe.cloud.couchbase.com?ssl=no_verify
206190
```
207191

208-
> **_NOTE_**: these Capella connection confguration examples should be used for development purposes only and are not recommended for production.
192+
> **_NOTE_**: these Capella connection configuration examples should be used for development purposes only and are not recommended for production.
209193
210194
Save your customized configuration and start the sample application by running the following command in the root folder of the project:
211-
>>>>>>> 066839e6fbc8c2f00fa28c21cd9a4472abeb62f1
212195

213196
```shell
214197
mvn spring-boot:run

0 commit comments

Comments
 (0)