Skip to content

Commit 972d7c9

Browse files
osfameronjeffrymorris
authored andcommitted
3.3-release-prep update start using
Also add Platform Help to nav
1 parent e699a15 commit 972d7c9

File tree

4 files changed

+28
-16
lines changed

4 files changed

+28
-16
lines changed

modules/ROOT/nav.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
.Getting Started
55
* xref:hello-world:start-using-sdk.adoc[Start Using the .NET SDK]
6-
// ** xref:hello-world:platform-help.adoc[Platform Introduction]
6+
** xref:hello-world:platform-help.adoc[Platform Introduction]
77
* xref:hello-world:sample-application.adoc[Sample Application]
88
99
.Working with Data

modules/devguide/examples/dotnet/Cloud.csx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,12 @@ class CloudExample
2020
{
2121
public async Task Main()
2222
{
23-
2423
// #tag::connect[]
25-
var cluster = await Cluster.ConnectAsync("couchbase://localhost", "username", "password");
24+
var cluster = await Cluster.ConnectAsync(
25+
// Update these credentials for your Capella instance!
26+
"couchbases://cb.njg8j7mwqnvwjqah.cloud.couchbase.com",
27+
"username",
28+
"Password!123");
2629
// #end::connect[]
2730

2831
// #tag::bucket[]
@@ -53,6 +56,5 @@ class CloudExample
5356
Console.WriteLine(row);
5457
}
5558
// end::n1ql-query[]
56-
5759
}
5860
}

modules/hello-world/examples/StartUsing.cs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ static async Task Main(string[] args)
1212
{
1313

1414
// #tag::connect[]
15-
var cluster = await Cluster.ConnectAsync("couchbase://localhost", "username", "password");
15+
var cluster = await Cluster.ConnectAsync(
16+
// Update these credentials for your Local Couchbase instance!
17+
"couchbase://localhost",
18+
"username",
19+
"password");
1620
// #end::connect[]
1721

1822
// #tag::bucket[]

modules/hello-world/pages/start-using-sdk.adoc

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,10 @@ If you are connecting to https://docs.couchbase.com/cloud/index.html[Couchbase C
2929
3030
[source,csharp]
3131
----
32-
include::devguide:example$dotnet/Cloud.cs[]
32+
include::devguide:example$dotnet/Cloud.csx[tags=**]
3333
----
34+
35+
The Couchbase Capella free trial version comes with the Travel Sample Bucket, and its Query indexes, loaded and ready.
3436
--
3537
3638
Local Couchbase Server::
@@ -41,6 +43,10 @@ Local Couchbase Server::
4143
include::example$StartUsing.cs[tags=**]
4244
----
4345
--
46+
47+
As well as the .NET SDK (see below), and a running instance of Couchbase Server, you will need to load up the Travel Sample Bucket
48+
using either the xref:{version-server}@server:manage:manage-settings/install-sample-buckets.adoc#install-sample-buckets-with-the-ui[Web interface]
49+
or the xref:{version-server}@server:manage:manage-settings/install-sample-buckets.adoc#install-sample-buckets-with-the-cli[command line].
4450
====
4551

4652

@@ -52,7 +58,7 @@ include::partial$supported.adoc[]
5258
See the xref:project-docs:compatibility.adoc#dotnet-compatibility[Compatibility] section for more details.
5359

5460

55-
=== Quick Install
61+
=== Quick Installation
5662

5763
The quickest way to get up and running is with NuGet, from the Package Manager Console, within your project:
5864

@@ -98,17 +104,19 @@ Then you can connect to the cluster:
98104

99105
[{tabs}]
100106
====
101-
Capella::
107+
Capella Connection::
102108
+
103109
--
104110
[source,csharp]
105111
----
106-
include::devguide:example$Cloud.cs[tag=connect,indent=0]
107-
112+
include::devguide:example$dotnet/Cloud.csx[tag=connect,indent=0]
108113
----
109-
--
110114
111-
Local Server::
115+
From 3.3, the .NET SDK includes Capella's standard certificates by default, so you do not need to additional configuration.
116+
You do need to enable TLS, which can be done by simply using `couchbases:` in the Connection String as in this example.
117+
See xref:howtos:managing-connections.adoc[Managing Connections] for full configuration details.
118+
--
119+
Local Server Connection::
112120
+
113121
--
114122
[source,csharp]
@@ -159,8 +167,6 @@ include::example$StartUsing.cs[tag=n1ql-query,indent=0]
159167
You can learn more about N1QL queries on the xref:howtos:n1ql-queries-with-sdk.adoc[Query page].
160168

161169

162-
163-
164170
== Next Steps
165171

166172
Now you're up and running, try one of the following:
@@ -181,8 +187,8 @@ Older API references are linked from their respective sections in the xref:proje
181187

182188
xref:project-docs:migrating-sdk-code-to-3.n.adoc[The Migrating from SDK2 to 3 page] highlights the main differences to be aware of when migrating your code from our earlier 2.x .NET SDK.
183189

184-
// Couchbase welcomes community contributions to the Python SDK.
185-
// The Python SDK source code is available on https://github.com/couchbase/couchbase-python-client[GitHub].
190+
// Couchbase welcomes community contributions to the .NET SDK.
191+
// The .NET SDK source code is available on https://github.com/couchbase/couchbase-net-client[GitHub].
186192

187193
=== Troubleshooting
188194

0 commit comments

Comments
 (0)