Skip to content

Qf210806 2 nav #489

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

Merged
merged 2 commits into from
Aug 6, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 2 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,6 @@ modules/swift/examples/CouchbaseLiteSwift.xcframework/**

modules/android/examples/docsnippets/**
modules/android/examples/jsonsnippets/**
temp-bin/**

tempbin/SampeCodeTest_extract270721.swift
temp-bin/duff-8142-Kotlin.tar
temp-bin/save-8132-210729.tar
temp-bin/save-8272-210729.tar
temp-bin/stage300-10Jun.tar
temp-bin/stage300-210729.tar
tempbin/**
6 changes: 3 additions & 3 deletions modules/ROOT/nav-prod-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ include::couchbase-lite:ROOT:partial$_page-index.adoc[]

.

// * {xref-cbl-pg-glossary}
// * {refer-glossary--xref}

// .Product Notes
// * {xref-cbl-pg-releasenotes-all}
// * {release-notes--xref-all}
// * {xref-cbl-pg-supportnotes-all}
// // * {xref-cbl-pg-changelog-all}
// * {xref-cbl-pg-compatibility-all}
// * {compatibility--xref-all}


//
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ include::ROOT:partial$_page-index.adoc[]
// .{component-title-cbl}
.xref:ROOT:introduction.adoc[Introduction]
// * xref:ROOT:whatsnew.adoc[What's New]
* {xref-cbl-pg-whatsnew}
* {whatsnew--xref}

// END::MENU STRUCTURE
237 changes: 138 additions & 99 deletions modules/ROOT/pages/_partials/_page-index.adoc

Large diffs are not rendered by default.

50 changes: 25 additions & 25 deletions modules/ROOT/pages/_partials/_related-content.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -84,16 +84,16 @@ Blog Entries
// P2PSYNC

// tag::how-p2psync[]
* {xref-cbl-pg-dbo-p2psync-websocket-using-passive}
* {p2psync-websocket-using-passive--xref}
* {p2psync-websocket-using-active--xref}
// * {xref-cbl-pg-p2p-manage-tls-id}
// end::how-p2psync[]

// tag::concept-p2psync[]
* {xref-cbl-pg-landing-p2psync}
// * {xref-cbl-pg-p2psync-custom}
// * {p2psync-custom--xref}
// * {xref-cbl-pg-replication}
// * {xref-cbl-pg-conflict}
// * {conflict--xref}
// end::concept-p2psync[]

// tag::reference-p2psync[]
Expand All @@ -103,18 +103,18 @@ Blog Entries
// Start

// tag::how-start[]
* {xref-cbl-pg-prereqs}
* {xref-cbl-pg-install}
* {xref-cbl-pg-build}
* {gs-prereqs--xref}
* {gs-install--xref}
* {gs-build--xref}

// end::how-start[]

// tag::concept-start[]
* {xref-cbl-pg-database}
* {xref-cbl-pg-document}
* {xref-cbl-pg-blob}
* {database--xref}
* {document--xref}
* {blob--xref}
* {xref-cbl-pg-replication}
* {xref-cbl-pg-conflict}
* {conflict--xref}

// end::concept-start[]

Expand All @@ -126,19 +126,19 @@ Blog Entries

// prod related
// tag::how-prod[]
* {xref-cbl-pg-releasenotes}
* {xref-cbl-pg-compatibility}
* {xref-cbl-pg-supported-os}
* {xref-cbl-pg-whatsnew}
* {release-notes--xref}
* {compatibility--xref}
* {supported-os--xref}
* {whatsnew--xref}

// end::how-prod[]

// tag::concept-prod[]
* {xref-cbl-pg-database}
* {xref-cbl-pg-document}
* {xref-cbl-pg-blob}
* {database--xref}
* {document--xref}
* {blob--xref}
* {xref-cbl-pg-replication}
* {xref-cbl-pg-conflict}
* {conflict--xref}

// end::concept-prod[]

Expand All @@ -147,17 +147,17 @@ Blog Entries
// end::references-prod[]
// prod related
// tag::how-query[]
* {xref-cbl-pg-query}
* {xref-cbl-pg-query-live}
* {xref-cbl-pg-query-predictive}
* {xref-cbl-pg-fts}
* {querybuilder--xref}
* {query-live--xref}
* {querybuilder--xref--predictive-query}
* {fts--xref}

// end::how-query[]

// tag::concept-query[]
* {xref-cbl-pg-database}
* {xref-cbl-pg-document}
* {xref-cbl-pg-blob}
* {database--xref}
* {document--xref}
* {blob--xref}

// end::concept-query[]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@

:topic-group: Peer-to-Peer Synchronization
:param-abstract: {url-api-references}[API Reference] | {xref-cbl-pg-p2psync-websocket} | {xref-cbl-pg-p2psync-custom}
:param-abstract: {url-api-references}[API Reference] | {p2psync-websocket--xref} | {p2psync-custom--xref}
8 changes: 4 additions & 4 deletions modules/ROOT/pages/_partials/block-related-content-p2p.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@

.How-to ...
* Peer-to-peer (websocket) sync
** {xref-cbl-pg-dbo-p2psync-websocket-using-passive} listener
** {p2psync-websocket-using-passive--xref} listener
** {p2psync-websocket-using-active--xref} listener
** {xref-cbl-pg-p2p-manage-tls-id}

.Learn more ...
* Peer-to-peer sync
** {xref-cbl-pg-p2psync-websocket}
** {xref-cbl-pg-p2psync-custom}
** {p2psync-websocket--xref}
** {p2psync-custom--xref}
* Related replication topics
** {xref-cbl-pg-replication}
** {xref-cbl-pg-conflict}
** {conflict--xref}

.Dive Deeper ...
* Reference content
Expand Down
14 changes: 7 additions & 7 deletions modules/ROOT/pages/_partials/block-related-content-rep.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,22 @@ include::partial$_block-related-content.adoc[]

// .How-to ...
// * Deploying Couchbase Lite for {param-platform}
// ** {xref-cbl-pg-prereqs}
// ** {xref-cbl-pg-install}
// ** {xref-cbl-pg-build}
// ** {gs-prereqs--xref}
// ** {gs-install--xref}
// ** {gs-build--xref}

// // * Next, try ...
// // ** {xref-cbl-pg-dbo-crud}
// // ** {xref-cbl-pg-dbo-query}

// .Learn more ...
// * Foundation concepts
// ** {xref-cbl-pg-database}
// ** {xref-cbl-pg-document}
// ** {xref-cbl-pg-blob}
// ** {database--xref}
// ** {document--xref}
// ** {blob--xref}
// * Related replication topics
// ** {xref-cbl-pg-replication}
// ** {xref-cbl-pg-conflict}
// ** {conflict--xref}

// .Dive Deeper ...
// * Reference content
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/_partials/block-related-content-std.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ include::partial$_block-related-content.adoc[]

// .How-to ...

// * {xref-cbl-pg-p2psync-custom}
// * {xref-cbl-pg-p2psync-websocket}
// * {p2psync-custom--xref}
// * {p2psync-websocket--xref}

// .Learn more ...

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@


:topic-group: Peer-to-Peer Synchronization
:param-related: {url-api-references}[API Reference] | {xref-cbl-pg-dbo-p2psync-websocket-using-passive} | {p2psync-websocket-using-active--xref}
:param-related: {url-api-references}[API Reference] | {p2psync-websocket-using-passive--xref} | {p2psync-websocket-using-active--xref}
// | {xref-cbl-pg-p2p-manage-tls-id}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

:param-abstract!:
:param-related: {xref-cbl-pg-replication} | {xref-cbl-pg-conflict}
:param-related: {xref-cbl-pg-replication} | {conflict--xref}
:topic-group: Replication
include::{root-partials}block-abstract.adoc[]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

// DO NOT REMOVE
:param-abstract: This content identifies the compatibility of Couchbase Lite on {param-title} with Sync Gateway, together with the operating systems upon which it is supported.
:param-related: {xref-cbl-pg-whatsnew} | {xref-cbl-pg-releasenotes} | {xref-cbl-pg-supported-os}
:param-related: {whatsnew--xref} | {release-notes--xref} | {supported-os--xref}
include::{root-partials}block-abstract.adoc[]

// DO NOT REMOVE
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/_partials/commons/common-database.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

include::{root-partials}_set-platform.adoc[]

:param-related: {xref-cbl-pg-blob} | {xref-cbl-pg-document} | {xref-cbl-pg-indexing}
:param-related: {blob--xref} | {document--xref} | {indexing--xref}
:topic-group: Topic Group -- Data Model
include::{root-partials}block-abstract.adoc[]

Expand Down Expand Up @@ -125,7 +125,7 @@ include::{root-partials}cli-tool.adoc[]
You should use Couchbase's console logs as your first source of diagnostic information.
If the information in the default logging level is insufficient you can focus it on database errors and generate more verbose messages -- see: <<ex-logdb>>.

For more on using Couchbase logs -- see: {xref-cbl-pg-troubleshooting-logs}.
For more on using Couchbase logs -- see: {troubleshooting-logs--xref}.

[#ex-logdb]
.Increase Level of Database Log Messages
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/_partials/commons/common-document.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Inclusion
:param-related: {xref-cbl-pg-database} | {xref-cbl-pg-blob} | {xref-cbl-pg-indexing} |
:param-related: {database--xref} | {blob--xref} | {indexing--xref} |
:topic-group: Topic Group -- Data Model
include::{root-partials}block-abstract.adoc[]

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/_partials/commons/common-fts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

// DO NOT EDIT
:param-abstract!:
:param-related: {xref-cbl-pg-query-predictive} | {xref-cbl-pg-indexing} | {xref-cbl-pg-query}
:param-related: {querybuilder--xref--predictive-query} | {indexing--xref} | {querybuilder--xref}
:topic-group: Queries
include::{root-partials}block-abstract.adoc[]
// DO NOT EDIT
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/_partials/commons/common-glossary.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ The TLSIdentity API differs from platform-to-platform.
* _Synonym(s)_: n/a
* _Topic Group_: _Using Peer-to-Peer Synchronization (web sockets_
* _Related Term(s)_: <<active-peer>> <<passive-peer>>
* _Read More_: {xref-cbl-pg-p2psync-websocket}
* _Read More_: {p2psync-websocket--xref}
// end::cbl-p2psync-tlsid-full[]

{goto-index}
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@ Couchbase{nbsp}Lite provides two options for implementing the required listener
* Optimize bandwidth -- built-in Delta-Sync support
* Sync securely -- built-in TLS encryption and authentication support
* Efficiently manage conflicts -- built-in conflict resolution support.
* {xref-cbl-pg-p2psync-websocket}
* {p2psync-websocket--xref}

[.column]
====== {empty}
[.content]
.Custom Build Listener
* A flexible framework enabling you to custom build a listener to meet your own requirements.
* {xref-cbl-pg-p2psync-custom}
* {p2psync-custom--xref}

++++
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ image::ROOT:docs-listener-diagram.png[,500]
[.column]
=== Locally
[.content]
You can replicate local databases _on-device_ -- see: {xref-cbl-pg-dbreplica}
You can replicate local databases _on-device_ -- see: {dbreplica--xref}

[.column]
=== Centrally
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/_partials/commons/common-logging.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ ifndef::snippet[:snippet: UNDEFINED-SNIPPET-PATH]
// Begin -- Output an abstract unless this inclusion is being used as part of an encompassing page
// Allow for external over-ride of default content
ifdef::param-fullpage[]
:tslinks: {xref-cbl-pg-troubleshooting-queries}
:tslinks: {troubleshooting-queries--xref}
ifdef::is-ios[]
:tslinks: {tslinks} | {xref-cbl-pg-troubleshooting-crashes}
:tslinks: {tslinks} | {troubleshooting-crashes--xref}
endif::[]
ifndef::param-related[:param-related: {tslinks}]
ifndef::topic-group[:topic-group: Troubleshooting]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ The passive side reacts to things that it receives but does not initiate any com

=== Websocket Listener

{xref-cbl-pg-p2psync-websocket}
{p2psync-websocket--xref}

=== Custom Listener

{xref-cbl-pg-p2psync-custom}
{p2psync-custom--xref}
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ include::{root-partials}block-abstract.adoc[]
[.narrow]
.Key Concepts
* API: {url-api-class-tlsidentity}
* {xref-cbl-pg-p2psync-websocket}
* {p2psync-websocket--xref}

== API References

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -165,11 +165,11 @@ include::{root-commons}sgw-replication-stop.adoc[]

== Conflict Resolution

Unless you specify otherwise, Couchbase Lite's default conflict resolution policy is applied -- see {xref-cbl-pg-conflict-auto}.
Unless you specify otherwise, Couchbase Lite's default conflict resolution policy is applied -- see {conflict--xref}.

To use a different policy, specify a _conflict resolver_ using {url-api-prop-replicator-config-conflict} as shown in <<using-conflict-resolvers>>.

For more complex solutions you can provide a custom conflict resolver - see: {xref-cbl-pg-conflict-custom}.
For more complex solutions you can provide a custom conflict resolver - see: {conflict--xref}.

// Example 10
[#using-conflict-resolvers]
Expand All @@ -180,7 +180,7 @@ To address that possibility, a version of the `Database.save()` method also take

include::{root-commons}conflict.adoc[tags=handling-conflicts-custom-merge]

For more on replicator conflict resolution see: {xref-cbl-pg-conflict}.
For more on replicator conflict resolution see: {conflict--xref}.


== Delta Sync
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Using these building blocks, developers can quickly implement peer-to-peer synch

====

As you can see this involves configuring a {xref-cbl-pg-dbo-p2psync-websocket-using-passive} and an
As you can see this involves configuring a {p2psync-websocket-using-passive--xref} and an
*** {p2psync-websocket-using-active--xref}; you can find the instructions to do that on those two links and see a simple listener configuration in <<simple-configuration>>

You can also learn more about how to implement peer-to-peer synchronization by referring to our tutorial -- see: {xref-cbl-pg-tutorial-p2psync}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ To retrieve the results of your query, you need to execute it using `Query.exec
The output from the execution is an array, with each array element representing the data from a document that matched your search criteria.

To unpack the results you need to iterate through this array.
Alternatively, you can convert the result to a JSON string -- see:


[#lbl-acc-all]
Expand Down
Loading