Skip to content

Test2 #6

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

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open

Test2 #6

wants to merge 16 commits into from

Conversation

osfameron
Copy link
Collaborator

No description provided.

* of items
** like this
** and this
** Users that are explicitly registered on Couchbase Server as _external_; as supported either by _LDAP_, _Security Assertion Markup Language (SAML)_, or _PAM_.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI:

Suggested change
** Users that are explicitly registered on Couchbase Server as _external_; as supported either by _LDAP_, _Security Assertion Markup Language (SAML)_, or _PAM_.
** Users that are explicitly registered on Couchbase Server as external, as supported either by LDAP, Security Assertion Markup Language (SAML), or PAM.

Using these Vale rules:

** and this
** Users that are explicitly registered on Couchbase Server as _external_; as supported either by _LDAP_, _Security Assertion Markup Language (SAML)_, or _PAM_.

Roles grant access to databases.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI:

Suggested change
Roles grant access to databases.
Roles grant use to databases.

Using these Vale rules:

  • Google.WordList (warning) - Use 'see', 'edit', 'find', 'use', or 'view' instead of 'access'.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From previous version of rule.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Notice how most recent version has NOT commented on this!

** Users that are explicitly registered on Couchbase Server as _external_; as supported either by _LDAP_, _Security Assertion Markup Language (SAML)_, or _PAM_.

Roles grant access to databases.
It's important not to access the database directly.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI:

Suggested change
It's important not to access the database directly.
It's important not to use the database directly.

Using these Vale rules:

  • Google.WordList (warning) - Use 'see', 'edit', 'find', 'use', or 'view' instead of 'access'.

@@ -1,3 +1,27 @@
# This is an example
:description: pass:q[Roles grant users access to one or more resources.]

Note that this role does not grant the ability to back up or restore users.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI:

Suggested change
Note that this role does not grant the ability to back up or restore users.
NOTE: This role does not grant the ability to back up or restore users.

Using these Vale rules:

  • Couchbase.NoteThat (error) - Don't use 'note that.' Convert to an actual NOTE, or don't use it at all.
  • Couchbase.DirectionalLanguage (warning) - Avoid directional language like 'up'.

@@ -0,0 +1,350 @@
= Integrate a Custom Built Listener
:page-aliases: learn/java-android-p2psync-custom.adoc
ifdef::show_edition[:page-edition: Enterprise Edition]

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
ifdef::show_edition[:page-edition: Enterprise Edition]
ifdef::show_edition[:page-edition: Couchbase Server Enterprise Edition]

Using these Vale rules:

  • Couchbase.CouchbaseServerEnterprise (error) - Use the full product name (Couchbase Server Enterprise Edition) first.


[abstract]
--
Description -- _{description}_ +

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
Description -- _{description}_ +
Description -- {description} +

Using these Vale rules:

[#overview]
== Overview

.Enterprise Edition only

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
.Enterprise Edition only
.Couchbase Server Enterprise Edition only

Using these Vale rules:

  • Couchbase.CouchbaseServerEnterprise (error) - Use the full product name (Couchbase Server Enterprise Edition) first.

To use it in production (also see the https://www.couchbase.com/licensing-and-support-faq[FAQ]).

This content covers how to integrate a custom __MessageEndpointListener__ solution with Couchbase Lite to handle the data transfer, which is the sending and receiving of data.
Where applicable, we discuss how to integrate Couchbase Lite into the workflow.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
Where applicable, we discuss how to integrate Couchbase Lite into the workflow.
Where applicable, this document discusses how to integrate Couchbase Lite into the workflow.

Using these Vale rules:

  • Google.We (warning) - Try to avoid using first-person plural like 'we'.

== Peer Discovery

Peer discovery is the first step.
The communication framework will generally include a Peer discovery API for devices to advertise themselves on the network and to browse for other Peers.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
The communication framework will generally include a Peer discovery API for devices to advertise themselves on the network and to browse for other Peers.
The communication framework generally includes a Peer discovery API for devices to advertise themselves on the network and to browse for other Peers.

Using these Vale rules:


. `uid`: a unique ID that represents the remote active Peer.
. `target`: This represents the remote passive Peer and could be any suitable representation of the remote Peer.
It could be an Id, URL etc.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
It could be an Id, URL etc.
It could be an Id, URL and so on.

Using these Vale rules:

It could be an Id, URL etc.
If using the MultiPeerConnectivity Framework, this could be the MCPeerID.
. `protocolType`: specifies the kind of transport you intend to implement.
There are two options.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
There are two options.
Two options exist.

Using these Vale rules:

  • write-good.ThereIs (error) - Don't start a sentence with 'There are'.
  • Couchbase.ThereIs (error) - Don't start a sentence with "there" + a form of "to be."

If using the MultiPeerConnectivity Framework, this could be the MCPeerID.
. `protocolType`: specifies the kind of transport you intend to implement.
There are two options.
** The default (`MessageStream`) means that you want to "send a series of messages", or in other words the Communication Framework will control the formatting of messages so that there are clear boundaries between messages.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
** The default (`MessageStream`) means that you want to "send a series of messages", or in other words the Communication Framework will control the formatting of messages so that there are clear boundaries between messages.
** The default (`MessageStream`) means that you want to "send a series of messages," or in other words the Communication Framework controls the formatting of messages so that there are clear boundaries between messages.

Using these Vale rules:

. `protocolType`: specifies the kind of transport you intend to implement.
There are two options.
** The default (`MessageStream`) means that you want to "send a series of messages", or in other words the Communication Framework will control the formatting of messages so that there are clear boundaries between messages.
** The alternative (`ByteStream`) means that you just want to send raw bytes over the stream and Couchbase should format for you to ensure that messages get delivered in full.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
** The alternative (`ByteStream`) means that you just want to send raw bytes over the stream and Couchbase should format for you to ensure that messages get delivered in full.
** The alternative (`ByteStream`) means that you just want to send raw bytes over the stream and Couchbase should format for you to make sure that messages get delivered in full.

Using these Vale rules:

** The default (`MessageStream`) means that you want to "send a series of messages", or in other words the Communication Framework will control the formatting of messages so that there are clear boundaries between messages.
** The alternative (`ByteStream`) means that you just want to send raw bytes over the stream and Couchbase should format for you to ensure that messages get delivered in full.
+
Typically, the Communication Framework will handle message assembly and disassembly so you would use the `MessageType` option in most cases.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
Typically, the Communication Framework will handle message assembly and disassembly so you would use the `MessageType` option in most cases.
Typically, the Communication Framework handles message assembly and disassembly so you would use the `MessageType` option in most cases.

Using these Vale rules:

+
Typically, the Communication Framework will handle message assembly and disassembly so you would use the `MessageType` option in most cases.

. `delegate`: the delegate that will implement the `MessageEndpointDelegate` protocol, which is a factory for `MessageEndpointConnection`.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
. `delegate`: the delegate that will implement the `MessageEndpointDelegate` protocol, which is a factory for `MessageEndpointConnection`.
. `delegate`: the delegate that implements the `MessageEndpointDelegate` protocol, which is a factory for `MessageEndpointConnection`.

Using these Vale rules:

include::android:example$codesnippet_collection.kt[tag=message-endpoint-replicator,indent=0]
----

Next, Couchbase Lite will call back the application code through the `MessageEndpointDelegate.createConnection` interface method.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
Next, Couchbase Lite will call back the application code through the `MessageEndpointDelegate.createConnection` interface method.
Next, Couchbase Lite calls back the application code through the `MessageEndpointDelegate.createConnection` interface method.

Using these Vale rules:

----
include::android:example$codesnippet_collection.kt[tag=create-connection,indent=0]
----
Next, Couchbase Lite will call back the application code through the `MessageEndpointConnection.open` method.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
Next, Couchbase Lite will call back the application code through the `MessageEndpointConnection.open` method.
Next, Couchbase Lite calls back the application code through the `MessageEndpointConnection.open` method.

Using these Vale rules:

The application code must keep track of every `ReplicatorConnection` associated with every `MessageEndpointConnection`.

The `MessageError` argument in the completion block specifies whether the error is recoverable or not.
If it is a recoverable error, the replicator will begin a retry process, creating a new `MessageEndpointConnection` instance.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
If it is a recoverable error, the replicator will begin a retry process, creating a new `MessageEndpointConnection` instance.
If it's a recoverable error, the replicator begins a retry process, creating a new `MessageEndpointConnection` instance.

Using these Vale rules:


`messageEndpointListener` is the instance of the `MessageEndpointListener` that was created in the first step (<<peer-discovery,Peer Discovery>>)

Couchbase Lite will call the application code back through the `MessageEndpointConnection.open` method.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
Couchbase Lite will call the application code back through the `MessageEndpointConnection.open` method.
Couchbase Lite calls the application code back through the `MessageEndpointConnection.open` method.

Using these Vale rules:


Once the data is sent, call the completion block to acknowledge the completion.
You can use the `MessageError` in the completion block to specify whether the error is recoverable.
If it is a recoverable error, the replicator will begin a retry process, creating a new `MessageEndpointConnection`.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
If it is a recoverable error, the replicator will begin a retry process, creating a new `MessageEndpointConnection`.
If it's a recoverable error, the replicator begins a retry process, creating a new `MessageEndpointConnection`.

Using these Vale rules:

include::android:example$codesnippet_collection.kt[tag=active-peer-receive,indent=0]
----

The replication connection's `receive` method is called. Which then processes the data to persist to the local database.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
The replication connection's `receive` method is called. Which then processes the data to persist to the local database.
The replication connection's `receive` method is called.
Which then processes the data to persist to the local database.

Using these Vale rules:

  • Couchbase.VentilatedProse (warning) - Use ventilated prose. Start every sentence on a new line.


Once the data is sent, call the completion block to acknowledge the completion.
You can use the `MessageError` in the completion block to specify whether the error is recoverable.
If it is a recoverable error, the replicator will begin a retry process, creating a new `MessageEndpointConnection`.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
If it is a recoverable error, the replicator will begin a retry process, creating a new `MessageEndpointConnection`.
If it's a recoverable error, the replicator begins a retry process, creating a new `MessageEndpointConnection`.

Using these Vale rules:

When a Peer disconnects from a Peer-to-Peer network, all connected Peers are notified.
The disconnect notification is a good opportunity to close and remove a replication connection.
The steps to Teardown the connection are slightly different depending on whether the active or passive Peer disconnects first.
We will cover each case below.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
We will cover each case below.
This document covers each case.

Using these Vale rules:

  • Google.We (warning) - Try to avoid using first-person plural like 'We'.
  • Google.Will (warning) - Avoid using 'will'.
  • Couchbase.DirectionalLanguage (warning) - Avoid directional language like 'below'.

include::android:example$codesnippet_collection.kt[tag=active-replicator-close,indent=0]
----

Then, Couchbase Lite will call back your code through the `MessageEndpointConnection.close` to allow the application to disconnect with the Communication Framework.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
Then, Couchbase Lite will call back your code through the `MessageEndpointConnection.close` to allow the application to disconnect with the Communication Framework.
Then, Couchbase Lite calls back your code through the `MessageEndpointConnection.close` to allow the application to disconnect with the Communication Framework.

Using these Vale rules:

include::android:example$codesnippet_collection.kt[tag=passive-replicator-close,indent=0]
----

Then, Couchbase Lite will call back your code through the `MessageEndpointConnection.close` to allow the application to disconnect with the Communication Framework.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
Then, Couchbase Lite will call back your code through the `MessageEndpointConnection.close` to allow the application to disconnect with the Communication Framework.
Then, Couchbase Lite calls back your code through the `MessageEndpointConnection.close` to allow the application to disconnect with the Communication Framework.

Using these Vale rules:

include::android:example$codesnippet_collection.kt[tag=passive-stop-listener,indent=0]
----

Then, Couchbase Lite will call back your code through the `MessageEndpointConnection.close` to allow the application to disconnect with the Communication Framework.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
Then, Couchbase Lite will call back your code through the `MessageEndpointConnection.close` to allow the application to disconnect with the Communication Framework.
Then, Couchbase Lite calls back your code through the `MessageEndpointConnection.close` to allow the application to disconnect with the Communication Framework.

Using these Vale rules:

include::android:example$codesnippet_collection.kt[tag=active-replicator-close,indent=0]
----

Then, Couchbase Lite will call back your code through the `MessageEndpointConnection.close` to allow the application to disconnect with the Communication Framework.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
Then, Couchbase Lite will call back your code through the `MessageEndpointConnection.close` to allow the application to disconnect with the Communication Framework.
Then, Couchbase Lite calls back your code through the `MessageEndpointConnection.close` to allow the application to disconnect with the Communication Framework.

Using these Vale rules:

@@ -1,3 +1,30 @@
# This is an example

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
# This is an example
# This Is An Example

Using these Vale rules:

  • Couchbase.Headings (warning) - 'This is an example' should use title-style capitalization.

@@ -1,3 +1,30 @@
# This is an example
:description: pass:q[Roles grant users access to one or more resources.]

Note that this role does not grant the ability to back up or restore users.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
Note that this role does not grant the ability to back up or restore users.
This role does not grant the ability to back up or restore users.

Using these Vale rules:

  • Couchbase.NoteThat (error) - Don't use 'note that.' Convert to an actual NOTE, or don't use it at all.
  • Couchbase.DirectionalLanguage (warning) - Avoid directional language like 'up'.


Here is a test example.
A second line on this example.

This page is about what is so good about couchbase server. And about couchbase capella.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
This page is about what is so good about couchbase server. And about couchbase capella.
This page is about what's so good about Couchbase Server.
And about Couchbase Capella.

Using these Vale rules:

  • Couchbase.Contractions (error) - Use 'what's' instead of 'what is'.
  • Vale.Terms (error) - Use 'Couchbase Server' instead of 'couchbase server'.
  • Couchbase.VentilatedProse (warning) - Use ventilated prose. Start every sentence on a new line.
  • Vale.Terms (error) - Use 'Couchbase' instead of 'couchbase'.
  • Vale.Terms (error) - Use 'Capella' instead of 'capella'.

* of items
** like this
** and this
** Users that are explicitly registered on Couchbase Server as _external_; as supported either by _LDAP_, _Security Assertion Markup Language (SAML)_, or _PAM_.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
** Users that are explicitly registered on Couchbase Server as _external_; as supported either by _LDAP_, _Security Assertion Markup Language (SAML)_, or _PAM_.
** Users that are explicitly registered on Couchbase Server as external, as supported either by LDAP, Security Assertion Markup Language (SAML), or PAM.

Using these Vale rules:

** Users that are explicitly registered on Couchbase Server as _external_; as supported either by _LDAP_, _Security Assertion Markup Language (SAML)_, or _PAM_.

Roles grant access to databases.
It's important not to access the database directly.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
It's important not to access the database directly.
It's important not to use the database directly.

Using these Vale rules:

  • Google.WordList (warning) - Use 'see', 'edit', 'find', 'use', or 'view' instead of 'to access'.


Roles grant access to databases.
It's important not to access the database directly.
Database access is great!

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
Database access is great!
Database access is great.

Using these Vale rules:

Roles grant access to databases.
It's important not to access the database directly.
Database access is great!
Role based access controls are awesome!

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
Role based access controls are awesome!
Role based access controls are awesome.

Using these Vale rules:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants