Details
-
Technical task
-
Resolution: Fixed
-
Major
-
None
-
None
-
None
-
None
-
0
Description
WHICH REPO/BRANCH
git clone git@github.com:couchbase/docs-couchbase-lite.git |
git checkout DOC-10385-Docs-for-Mobile-Scopes-and-Collections |
git pull # update |
git checkout -b |
WHAT DOCUMENT
We'll start with just C#.net again, and make abstract in a subsequent step.
This is the following 4 pages under Data Sync > Peer to Peer:
- https://docs.couchbase.com/couchbase-lite/current/csharp/p2psync-websocket.html
- https://docs.couchbase.com/couchbase-lite/current/csharp/p2psync-websocket-using-passive.html
- https://docs.couchbase.com/couchbase-lite/current/csharp/p2psync-websocket-using-active.html
- https://docs.couchbase.com/couchbase-lite/current/csharp/p2psync-custom.html
Because this is an existing doc, it's more complicated to work with.
- START OFF by opening this doc in your Web Browser, and reading through it, alongside the WHAT TO DO section below.
- Figure out what you want to change...
- (we'll then figure out where below)
WHAT TO DO
Requirements:
- Replication document events must include fully qualified keyspace of documents. This is because a replicator can be defined at database, scope level or collection level.
- The section "Data Sync in Couchbase Lite" in the PRD looks like it might be readable? https://docs.google.com/document/d/1JEeAn_BO6ZbsIhOlT4WpRj3xwJnCot606nZZuG0_CLY/edit#heading=h.oue0xld2yjp5
- Also "Mapping Rules" section https://docs.google.com/document/d/1JEeAn_BO6ZbsIhOlT4WpRj3xwJnCot606nZZuG0_CLY/edit#heading=h.g5ql5go3gyyi
- (All of this looks quite complicated)
- The Overview page
- probably needs a paragraph on how this works.
- Example code uses e.g. thisDB in examples. Guess we need to show a few variants, like Listener or Replicator pointing at database OR scope OR collection.
- Passive Peer
- code samples need tweaking as above
- (whole TLS section shouldn't change)
- Active Peer
- code samples need tweaking as above
- Integrate Custom Peer
- code samples need tweaking as above
- lots of excellent (complex) diagrams, that I'm not sure if they need work
WHERE (WHAT FILES TO UPDATE)
Start at the top, and notice how each file include::'s others.
I'll list the ones I think might be most important, and happy to help chase down include chains if it's important.
- modules/csharp/pages/p2psync-websocket.adoc (ENTRYPOINT, but very abstract)
- modules/ROOT/pages/_partials/commons/common-p2psync-websocket.adoc
- modules/csharp/examples/code_snippets/Program.cs
- source code tags:
- listener-simple
- replicator-simple
- modules/csharp/pages/p2psync-websocket-using-passive.adoc (ENTRYPOINT, but very abstract)
- modules/ROOT/pages/_partials/commons/common-p2psync-websocket-using-passive.adoc
- modules/csharp/examples/code_snippets/Program.cs
- source code tags:
listener-initialize
listener-config-db
listener-config-port
listener-config-netw-iface- listener-get-network-interfaces
listener-config-delta-sync
(ignore the TLS ones)
listener-config-client-auth-pwd
listener-config-client-auth-root
listener-config-client-auth-lambda
listener-start
listener-status-check
listener-stop
- modules/csharp/pages/p2psync-websocket-using-active.adoc (ENTRYPOINT, but very abstract)
- modules/ROOT/pages/_partials/commons/common-p2psync-websocket-using-active.adoc
- modules/csharp/examples/code_snippets/Program.cs
- source code tags:
p2p-act-rep-func
p2p-act-rep-auth
p2p-tlsid-tlsidentity-with-label- OH GOD THERE's MORE PARTIALS
- OK, this triage needs more work
- modules/csharp/pages/p2psync-custom.adoc (ENTRYPOINT, but very abstract)
- modules/ROOT/pages/_partials/commons/common-p2psync-custom.adoc
- modules/csharp/examples/code_snippets/Program.cs
- source code tags:
- listener
- message-endpoint
- message-endpoint-replicator
- create-connection
- active-peer-open
- advertizer-accept
- passive-peer-open
- active-peer-send
- active-peer-receive
- passive-peer-send
- passive-peer-receive
- active-replicator-close
- active-peer-close
- passive-replicator-close
- passive-peer-close
- passive-stop-listener
- passive-peer-close
- active-replicator-close
- active-peer-close
Updating a Code Example
First step: figure out what needs changing.
see https://issues.couchbase.com/browse/DOC-10659 for a more detailed explanation of the process of updating a code sample.