From 5bfe3a44588fe51475c6f9b9a807d2a54cc3e406 Mon Sep 17 00:00:00 2001
From: leogermani <leogermani@gmail.com>
Date: Thu, 18 Aug 2022 13:08:17 -0300
Subject: [PATCH] improve connection docs (#25703)

* improve connection docs

* bump version
---
 projects/packages/connection/README.md        |  7 ++---
 .../changelog/update-connection-docs          |  4 +++
 .../packages/connection/docs/register-site.md | 30 ++++++++++---------
 .../connection/src/class-package-version.php  |  2 +-
 4 files changed, 23 insertions(+), 20 deletions(-)
 create mode 100644 projects/packages/connection/changelog/update-connection-docs

diff --git a/projects/packages/connection/README.md b/projects/packages/connection/README.md
index 5dc5e462cf048..482991d8229cd 100644
--- a/projects/packages/connection/README.md
+++ b/projects/packages/connection/README.md
@@ -14,11 +14,8 @@ Package is published in [Packagist](https://packagist.org/packages/automattic/je
 }
 ```
 
-## Examples
-1. [Register the site](docs/register-site.md)
-2. [Authorize the user](docs/authorize-user.md)
-3. In-place user auth @todo
-4. Disconnecting @todo
+## Guides
+* [Connection package guide](docs/register-site.md)
 
 ## Tools
 
diff --git a/projects/packages/connection/changelog/update-connection-docs b/projects/packages/connection/changelog/update-connection-docs
new file mode 100644
index 0000000000000..52cf6b5461510
--- /dev/null
+++ b/projects/packages/connection/changelog/update-connection-docs
@@ -0,0 +1,4 @@
+Significance: patch
+Type: fixed
+
+improved docs
diff --git a/projects/packages/connection/docs/register-site.md b/projects/packages/connection/docs/register-site.md
index 7c18f6cf259d3..5d3c6fea5afdb 100644
--- a/projects/packages/connection/docs/register-site.md
+++ b/projects/packages/connection/docs/register-site.md
@@ -4,7 +4,7 @@ This means registering the site with WordPress.com. It will create a "site (or '
 
 The blog token is required in order to [authenticate at a user level](authorize-user.md) later (link to user auth docs here), so let's learn the simplest way we can do that in your plugin.
 
-### Install the right packages
+## Install the right packages
 
 First, let's make sure that the `automattic/jetpack-connection` package is set up in your composer.json file:
 
@@ -32,7 +32,7 @@ We recommend that you always use the latest published versions of our packages,
 }
 ```
 
-### Initialize the package
+## Initialize the package
 
 Second, we must initialize ("configure") the `jetpack-connection` package within your plugin, and provide the information about it.
 
@@ -60,6 +60,12 @@ function jpcs_load_plugin() {
 add_action( 'plugins_loaded', 'jpcs_load_plugin', 1 );
 ```
 
+## Connecting the site and the users
+
+In the JS connection package (see js-packages/connection folder in the monorepo) you'll find the React components that handle all the connection process for you out of the box. If you can, prefer to use them.
+
+If you need to build your own connection flow from scratch, here is how to do it:
+
 ### Make an API call to register the site
 
 You can then make an API POST call to `jetpack/v4/connection/register` to register the site.
@@ -123,20 +129,16 @@ $manager->disconnect_site_wpcom();
 $manager->delete_all_connection_tokens();
 ```
 
-#### Using the connection
-If the plugin was *softly* disconnected, the access tokens will still be accessible.
-However, the user explicitly requested the plugin to be disabled, so you need to check for that before you utilize the connection in any way:
-```php
-$manager = new Manager( 'plugin-slug' );
+### Using the connection
 
-if ( $manager->is_plugin_enabled() && ( new Tokens() )->get_access_token() ) {
-	// Perform the API requests.
-} else {
-	// Assume the plugin is disconnected, no matter if the tokens actually exist.
-}
-```
+The `Connection::Manager` class gives you several methods to check on the connection status and act accordingly. Here are some of the most useful methods:
+
+* `is_connected()`: Checks if the site has a site-level connection. aka has a blog token.
+* `has_connected_owner()`: Checks if the site has an admin connected and marked as the connection owner.
+* `is_user_connected()`: Checks if the current user (or any given user) is connected (authorized in wpcom).
+* `is_site_connection()`: Checks if the site is connected only at a site level. Similar to `is_connected` but will diferentiate if this is truly a site-only connection and not a site that has a broken user connection.
 
-#### Reconnecting
+### Reconnecting
 
 There's a method that handles reconnection in case you need to refresh your connection. This will destroy the connection and start a new connection flow. Note that you still need to authorize the user after reconnecting.
 
diff --git a/projects/packages/connection/src/class-package-version.php b/projects/packages/connection/src/class-package-version.php
index 8963af5064ff9..7a718c18e4da4 100644
--- a/projects/packages/connection/src/class-package-version.php
+++ b/projects/packages/connection/src/class-package-version.php
@@ -12,7 +12,7 @@
  */
 class Package_Version {
 
-	const PACKAGE_VERSION = '1.42.0';
+	const PACKAGE_VERSION = '1.42.1-alpha';
 
 	const PACKAGE_SLUG = 'connection';