diff --git a/antora.yml b/antora.yml index b721905..6d44946 100644 --- a/antora.yml +++ b/antora.yml @@ -1,5 +1,6 @@ name: tutorials version: 'master' title: Tutorials +display-version: 3.0 nav: - modules/ROOT/nav.adoc \ No newline at end of file diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 13f536f..b9c85e5 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -1,36 +1,42 @@ include::partial$_attributes-local.adoc[] -.Developer Bootstrap Exercises -include::quick-start:partial$nav.adoc[] +.Get Started with Couchbase Capella Self-Service Trials +include::cbc-self-service-trials:partial$nav.adoc[] -.Getting Started with Couchbase Community Edition +.Get Started with Couchbase Community Edition include::getting-started-ce:partial$nav.adoc[] -.Tutorials +.Developer Bootstrap Exercises +include::quick-start:partial$nav.adoc[] + .Couchbase Server * Session Storage include::session-storage:partial$nav.adoc[] +xref::session-storage:partial$nav.adoc[] * User Profile Storage include::profile-store:partial$nav.adoc[] .Couchbase Mobile - -* Travel Sample -include::mobile-travel-sample:partial$nav.adoc[] -* xref:standalone@userprofile-couchbase-mobile:userprofile:userprofile_basic.adoc[Getting Started on iOS] -* xref:standalone@userprofile-couchbase-mobile:userprofile:xamarin/userprofile_basic.adoc[Getting Started on Xamarin] -* xref:standalone@userprofile-couchbase-mobile:userprofile:android/userprofile_basic.adoc[Getting Started on Android] -// * Getting Started with Peer-to-Peer Sync +// Couchbase Mobile Workshop +include::mobile-travel-tutorial:partial$nav.adoc[] +// Getting Started on iOS +include::userprofile-sync:partial$nav.adoc[] +// Getting Started on Xamarin +include::userprofile-sync-xamarin:partial$nav.adoc[] +// Getting Started on Android +include::userprofile-sync-android:partial$nav.adoc[] +// Peer-to-Peer include::cbl-p2p-sync-websockets:partial$nav.adoc[] -* Xcode Playground -** xref:tutorials:swift-playground:overview.adoc[Overview] -* Recycler Views with Live Queries$nav.adoc[] -* Build a Cordova Plugin -include::hotel-lister:partial$nav.adoc[] -* Build a React Native Module -include::hotel-finder:partial$nav.adoc[] -* OpenID Connect Tutorial -include::openid-connect-implicit-flow:partial$nav.adoc[] + +// * xref:tutorials:swift-playground:overview.adoc[Xcode Playground] +// * Recycler Views with Live Queries +// include::university-lister:partial$nav.adoc[] +// * Build a Cordova Plugin +// include::hotel-lister:partial$nav.adoc[] +// * Build a React Native Module +// include::hotel-finder:partial$nav.adoc[] +// * OpenID Connect Tutorial +// include::openid-connect-implicit-flow:partial$nav.adoc[] .Build Your Own * Tutorial Template diff --git a/modules/ROOT/pages/_partials/p2p-sync-entry-skeleton.adoc b/modules/ROOT/pages/_partials/p2p-sync-entry-skeleton.adoc index 4753dbe..8b0179d 100644 --- a/modules/ROOT/pages/_partials/p2p-sync-entry-skeleton.adoc +++ b/modules/ROOT/pages/_partials/p2p-sync-entry-skeleton.adoc @@ -33,7 +33,10 @@ This tutorial uses a simple inventory tracker app to demonstrate the peer-to-pee [.box] .Component -* Couchbase Lite 2.8 +* Couchbase Lite {param-version} +* Visual Studio 2019+ +* .Net Core 3.1 +* Xamarin Forms 5.0.0.2012 [.box] .Languages diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 76e425c..976831d 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -33,8 +33,8 @@ pass:[] [.data-filter-column] ====== {empty} ++++ -
-

Developer Bootstrap Exercises

+
+

Couchbase Capella First-Timer Tutorial Series

++++ pass:attributes[
Beginner
Developer] @@ -44,9 +44,9 @@ pass:attributes[
Beginner
D ++++ [.content] -Are you a developer interested in a fast start with Couchbase? This expanding set of basic first-steps exercises provide a fast track from zero to your substantial interactions with Couchbase Server using your favorite development frameworks and IDEs. +This series of “First Timer” tutorials is intended to get you going quickly with your Couchbase Capella FREE Trial and provide a whirlwind tour of important Couchbase Capella capabilities at a high level. -xref:quick-start:quickstart-docker-image-manual-cb65.adoc[Start Here] +xref:cbc-self-service-trials:index.adoc[Start Here] ++++
@@ -56,23 +56,13 @@ xref:quick-start:quickstart-docker-image-manual-cb65.adoc[Start Here] [.component] .Component -* Server 6.5 CE or EE -* SDK 3.0 or 2.x - -[.box] -[.languages] - -.Languages -* Java -* Node.js -* .NET +* Couchbase Capella ++++
++++ - [.column] [.data-filter-column] ====== {empty} @@ -111,6 +101,54 @@ xref:getting-started-ce:index.adoc[Start Here]
++++ +[.column] +[.data-filter-column] +====== {empty} +++++ +
+

Developer Bootstrap Exercises

+
+++++ +pass:attributes[
Beginner
Developer] +++++ +
+
+++++ +[.content] + +Are you a developer interested in a fast start with Couchbase? This expanding set of basic first-steps exercises provide a fast track from zero to your substantial interactions with Couchbase Server using your favorite development frameworks and IDEs. + +xref:quick-start:quickstart-docker-image-manual-cb65.adoc[Start Here] + +++++ +
+++++ + +[.box] +[.component] + +.Component +* Server 6.5 CE or EE +* SDK 3.0 or 2.x + +[.box] +[.languages] + +.Languages +* Java +* Node.js +* .NET + +++++ +
+++++ + + +// Get Started with Couchbase Mobile + + +// Userprofile -- iOS + [.column] [.data-filter-column] ====== {empty} @@ -124,40 +162,46 @@ pass:attributes[
Beginner
M
++++ -[.content] -The series of tutorials demonstrates the core capabilities of Couchbase Mobile with an iOS app: +[.content style="list-style: square;"] +:standalone--xref: xref:userprofile-standalone:userprofile_basic.adoc[Standalone] +:query--xref: xref:userprofile-query:userprofile_query.adoc[Query] +:sync--xref: xref:userprofile-sync:userprofile_sync.adoc[Sync] -* "Standalone": database and CRUD operations. -* "Query": querying capabilities. -* "Sync": use of Sync Gateway for data sync between clients. +The series of tutorials demonstrates the core capabilities of Couchbase Mobile with an iOS app: +* {standalone--xref}: Learn about Couchbase Lite's database and CRUD operations. +* {query--xref}: Explore Couchbase Lite's query capabilities. +* {sync--xref}: Couple Couchbase Lite with Sync Gateway to tap into the power of data sync. ++++
++++ [.box] - -* xref:standalone@userprofile-couchbase-mobile:userprofile:userprofile_basic.adoc[Standalone] -* xref:query@userprofile-couchbase-mobile:userprofile:userprofile_query.adoc[Query] -* xref:sync@userprofile-couchbase-mobile:userprofile:userprofile_sync.adoc[Sync] - +.Modules +* {standalone--xref} +* {query--xref} +* {sync--xref} [.box] -.Component -* Server 5.5 -* Couchbase Lite 2.1 -* Sync Gateway 2.1 +.Components +* Server 7.0 +* Couchbase Lite 3.0 +* Sync Gateway 3.0 [.box] .Languages -* Swift +* iOS 12 +* Swift 5.5 +* Xcode 12.5 ++++
++++ +// Userprofile -- Android + [.column] [.data-filter-column] ====== {empty} @@ -185,17 +229,16 @@ The series of tutorials demonstrates the core capabilities of Couchbase Mobile w ++++ [.box] - -* xref:standalone@userprofile-couchbase-mobile:userprofile:android/userprofile_basic.adoc[Standalone] -* xref:query@userprofile-couchbase-mobile:userprofile:android/userprofile_query.adoc[Query] -* xref:sync@userprofile-couchbase-mobile:userprofile:android/userprofile_sync.adoc[Sync] - +.Modules +* xref:userprofile-standalone-android:userprofile_basic.adoc[Standalone] +* xref:userprofile-query-android:userprofile_query.adoc[Query] +* xref:userprofile-sync-android:userprofile_sync.adoc[Sync] [.box] .Component -* Server 5.5 -* Couchbase Lite 2.6 -* Sync Gateway 2.6 +* Server 7.0 +* Couchbase Lite 3.0 +* Sync Gateway 3.0 [.box] .Languages @@ -205,6 +248,8 @@ The series of tutorials demonstrates the core capabilities of Couchbase Mobile w ++++ +// Userprofile -- Xamarin (.Net) + [.column] [.data-filter-column] ====== {empty} @@ -233,16 +278,15 @@ The series of tutorials demonstrates the core capabilities of Couchbase Mobile w [.box] -* xref:standalone@userprofile-couchbase-mobile:userprofile:xamarin/userprofile_basic.adoc[Standalone] -* xref:query@userprofile-couchbase-mobile:userprofile:xamarin/userprofile_query.adoc[Query] -* xref:sync@userprofile-couchbase-mobile:userprofile:xamarin/userprofile_sync.adoc[Sync] - +* xref:userprofile-standalone-xamarin:userprofile_basic.adoc[Standalone] +* xref:userprofile-query-xamarin:userprofile_query.adoc[Query] +* xref:userprofile-sync-xamarin:userprofile_sync.adoc[Sync] [.box] .Component -* Server 5.5 -* Couchbase Lite 2.1 -* Sync Gateway 2.1 +* Server 7.0 +* Couchbase Lite 3.0 +* Sync Gateway 3.0 [.box] .Languages @@ -252,119 +296,171 @@ The series of tutorials demonstrates the core capabilities of Couchbase Mobile w ++++ -// BEGIN include P2P sync over websocket tutorials - one entry per language/platform +// Couchbase Mobile -- Peer to Peer + + +// BEGIN include P2P sync over websocket tutorials - one entry per language/platform :param-language: Swift :param-platform: iOS :param-module: swift +:param-version: 3.0 include::partial$p2p-sync-entry-skeleton.adoc[] // Uncomment the following as the platforms are available // :param-language: Java // :param-module: java +// :param-version: 2.8 // include::partial$p2p-sync-entry-skeleton.adoc[] // :param-language: Android (Java) // :param-module: android // :param-platform: Android +// :param-version: 2.8 // include::partial$p2p-sync-entry-skeleton.adoc[] -// :param-language: C#.Net -// :param-platform: Xamarin -// :param-module: csharp -// include::partial$p2p-sync-entry-skeleton.adoc[] - -// END include P2P sync over websocket tutorials - one entry per language/platform - - -[.column] -[.data-filter-column] -====== {empty} -++++ -
-

Background Fetch with Couchbase Lite on iOS

-
-++++ -pass:attributes[
Beginner
Mobile Developer] -++++ -
-
-++++ -[.content] - -This tutorial discusses how you can use iOS Background App Refresh capability to sync data when in the background. - -++++ -
-++++ - -[.box] - -* xref:backgroundfetch@userprofile-couchbase-mobile:userprofile:background-fetch.adoc[Start Here] - - -[.box] -.Component -* Server 5.5 -* Couchbase Lite 2.1 -* Sync Gateway 2.1 - -[.box] -.Languages -* Swift - -++++ -
-++++ - -[.column] -[.data-filter-column] -====== {empty} -++++ -
-

Building a Cordova Plugin with Couchbase Lite

-
-++++ -pass:attributes[
Beginner
Mobile Developer] -++++ -
-
-++++ -[.content] - -In this tutorial, you will learn how to use Couchbase Lite in a Cordova plugin for an Ionic project targeting iOS and Android. -The user Interface is written in JavaScript while the business logic and data model is written in native Swift/Java. +:param-language: C# +:param-platform: Xamarin +:param-module: dotnet +:param-version: 3.0 -++++ -
-++++ - -[.box] +include::partial$p2p-sync-entry-skeleton.adoc[] -* xref:tutorials:hotel-lister:ios.adoc[Swift] -* xref:tutorials:hotel-lister:android.adoc[Java] +// END include P2P sync over websocket tutorials - one entry per language/platform -[.box] -.Component -* Couchbase Lite 2.1 -[.box] -.Languages -* Swift -* Java -* Javascript +// [.column] +// [.data-filter-column] +// ====== {empty} +// ++++ +//
+//

Background Fetch with Couchbase Lite on iOS

+//
+// ++++ +// pass:attributes[
Beginner
Mobile Developer] +// ++++ +//
+//
+// ++++ +// [.content] + +// This tutorial discusses how you can use iOS Background App Refresh capability to sync data when in the background. + +// ++++ +//
+// ++++ + +// [.box] + +// * xref:backgroundfetch@userprofile-couchbase-mobile:userprofile:background-fetch.adoc[Start Here] + + +// [.box] +// .Component +// * Server 5.5 +// * Couchbase Lite 2.1 +// * Sync Gateway 2.1 + +// [.box] +// .Languages +// * Swift + +// ++++ +//
+// ++++ + +// CORDOVA TUTORIAL +// [.column] +// [.data-filter-column] +// ====== {empty} +// ++++ +//
+//

Building a Cordova Plugin with Couchbase Lite

+//
+// ++++ +// pass:attributes[
Beginner
Mobile Developer] +// ++++ +//
+//
+// ++++ +// [.content] + +// In this tutorial, you will learn how to use Couchbase Lite in a Cordova plugin for an Ionic project targeting iOS and Android. +// The user Interface is written in JavaScript while the business logic and data model is written in native Swift/Java. + +// ++++ +//
+// ++++ + +// [.box] + +// * xref:tutorials:hotel-lister:ios.adoc[Swift] +// * xref:tutorials:hotel-lister:android.adoc[Java] + +// [.box] +// .Component +// * Couchbase Lite 2.1 + +// [.box] +// .Languages +// * Swift +// * Java +// * Javascript + +// ++++ +//
+// ++++ + +// REACT TUTORIAL +// [.column] +// [.data-filter-column] +// ====== {empty} +// ++++ +//
+//

Building a React Native Module with Couchbase Lite

+//
+// ++++ +// pass:attributes[
Beginner
Mobile Developer] +// ++++ +//
+//
+// ++++ +// [.content] + +// In this tutorial, you will learn how to use Couchbase Lite in a React Native project for iOS and Android. +// The user Interface is written in JavaScript while the business logic and data model is written in native Swift/Java. + +// ++++ +//
+// ++++ + +// [.box] + +// * xref:tutorials:hotel-finder:ios.adoc[Swift] +// * xref:tutorials:hotel-finder:android.adoc[Java] + +// [.box] +// .Component +// * Couchbase Lite 2.6 + +// [.box] +// .Languages +// * Swift +// * Java +// * Javascript + +// ++++ +//
+// ++++ -++++ -
-++++ [.column] [.data-filter-column] ====== {empty} ++++ -
-

Building a React Native Module with Couchbase Lite

+
+

Xcode playground for Couchbase Lite Query

++++ pass:attributes[
Beginner
Mobile Developer] @@ -374,8 +470,7 @@ pass:attributes[
Beginner
M ++++ [.content] -In this tutorial, you will learn how to use Couchbase Lite in a React Native project for iOS and Android. -The user Interface is written in JavaScript while the business logic and data model is written in native Swift/Java. +A Xcode Playground to explore the Query API in Couchbase Lite 2.x. While the playground demonstrates the queries in swift, given the unified nature of the QueryBuilder API, you should be able to easily translate the queries to any of the other platform languages supported on Couchbase Lite. ++++
@@ -383,59 +478,57 @@ The user Interface is written in JavaScript while the business logic and data mo [.box] -* xref:tutorials:hotel-finder:ios.adoc[Swift] -* xref:tutorials:hotel-finder:android.adoc[Java] +* xref:tutorials:swift-playground:overview.adoc[Start Here] [.box] .Component -* Couchbase Lite 2.6 +* Couchbase Lite 2.8.1 [.box] .Languages * Swift -* Java -* Javascript ++++
++++ -[.column] -[.data-filter-column] -====== {empty} -++++ -
-

Android Recycler Views with Couchbase Lite

-
-++++ -pass:attributes[
Beginner
Mobile Developer] -++++ -
-
-++++ -[.content] +// RECYCLER VIEW TUTORIAL +// [.column] +// [.data-filter-column] +// ====== {empty} +// ++++ +//
+//

Android Recycler Views with Couchbase Lite

+//
+// ++++ +// pass:attributes[
Beginner
Mobile Developer] +// ++++ +//
+//
+// ++++ +// [.content] -This tutorial will demonstrate how you can use Couchbase Lite as a data source for Recycler Views in your Android application. +// This tutorial will demonstrate how you can use Couchbase Lite as a data source for Recycler Views in your Android application. -++++ -
-++++ +// ++++ +//
+// ++++ -[.box] +// [.box] -* xref:tutorials:university-lister:android.adoc[Start Here] +// * xref:tutorials:university-lister:android.adoc[Start Here] -[.box] -.Component -* Couchbase Lite 2.1 +// [.box] +// .Component +// * Couchbase Lite 2.1 -[.box] -.Languages -* Java +// [.box] +// .Languages +// * Java -++++ -
-++++ +// ++++ +//
+// ++++ [.column] [.data-filter-column] @@ -517,43 +610,6 @@ An comprehensive tutorial that demonstrates how to use Couchbase Server, Spring
++++ -[.column] -[.data-filter-column] -====== {empty} -++++ -
-

Xcode playground for Couchbase Lite Query

-
-++++ -pass:attributes[
Beginner
Mobile Developer] -++++ -
-
-++++ -[.content] - -A Xcode Playground to demonstrate and explore the Query interface in Couchbase Lite 2.0. While the playground demonstrates the queries in swift, given the unified nature of the QueryBuilder API, you should be able to easily translate the queries to any of the other platform languages supported on Couchbase Lite. - -++++ -
-++++ - -[.box] - -* xref:tutorials:swift-playground:overview.adoc[Start Here] - -[.box] -.Component -* Couchbase Lite 2.1 - -[.box] -.Languages -* Swift - -++++ -
-++++ - [.column] [.data-filter-column] ====== {empty} @@ -570,7 +626,8 @@ pass:attributes[
Intermediate
@@ -578,23 +635,23 @@ At the end of this multi-part tutorial, you should have a good understanding of [.box] -* xref:tutorials:mobile-travel-sample:introduction.adoc[Start Here] -* xref:tutorials:mobile-travel-sample:swift/installation/index.adoc[iOS] -* xref:tutorials:mobile-travel-sample:android/installation/index.adoc[Android] -* xref:tutorials:mobile-travel-sample:java/installation/index.adoc[Java] -* xref:tutorials:mobile-travel-sample:csharp/installation/index.adoc[.NET] +* xref:tutorials:mobile-travel-tutorial:introduction.adoc[Start Here] +* xref:tutorials:mobile-travel-tutorial:swift/installation/index.adoc[iOS] +* xref:tutorials:mobile-travel-tutorial:android/installation/index.adoc[Android] +* xref:tutorials:mobile-travel-tutorial:java/installation/index.adoc[Java] +* xref:tutorials:mobile-travel-tutorial:csharp/installation/index.adoc[.NET] [.box] .Component -* Couchbase Server 6.5 -* Couchbase Lite 2.7 -* Sync Gateway 2.7 +* Couchbase Server 7.0 +* Couchbase Lite 3.0 +* Sync Gateway 3.0 [.box] .Languages * Swift * Java (Android and Desktop) -* C# +* C#/.Net/Xamarin ++++