From 0f33f4a8af7e7e20701d4a4e91dde196d945056a Mon Sep 17 00:00:00 2001
From: Pasha Fateev <pasha@autokitteh.com>
Date: Thu, 2 Jan 2025 15:49:08 -0800
Subject: [PATCH] docs: reorganize `reviewkitteh` README to favor cloud (#142)

& minor tweak in `room_reservation`
---
 reviewkitteh/README.md     | 78 +++++++-------------------------------
 room_reservation/README.md |  2 +-
 2 files changed, 14 insertions(+), 66 deletions(-)

diff --git a/reviewkitteh/README.md b/reviewkitteh/README.md
index 4d8c9637..5a9082fc 100644
--- a/reviewkitteh/README.md
+++ b/reviewkitteh/README.md
@@ -11,77 +11,25 @@ This project automates the process of listening for GitHub pull request events a
 
 ## How It Works
 
-1. **Trigger**: The workflow is triggered by a GitHub pull request event (opened or reopened).
-2. **Post to Slack**: The program posts an initial message to the Slack channel and continues to update the message as the pull request's state changes.
-3. **Random Paging**: Every 15 seconds, the program selects a random person from a Google Sheet and pages them in the Slack channel.
-4. **Completion**: The workflow continues until the pull request is closed or merged.
+1.	Receive GitHub pull request events (opened or reopened)
+2.	Post updates to Slack with an initial message and dynamic updates as the pull request’s status changes
+3.	Page team members by selecting a random person from a Google Sheet every 15 seconds and notifying them in Slack
+4.	Conclude workflow when the pull request is closed or merged
 
-## Installation and Usage 
+## Cloud Usage (Recommended)
 
-- [Install AutoKitteh](https://docs.autokitteh.com/get_started/install)
-
-### Configure integrations
+1. Initialize your connections through the UI
+2. Set the `CHANNEL_ID`, `ORG_DOMAIN`, and `SHEET_ID` project variables in the "VARIABLES" tab
 
 > [!IMPORTANT]
->  The `autokitteh.yaml` file includes environment variables for the GitHub, Slack, and Google Sheets connections that need to be configured. When setting the `CHANNEL` variable, be sure to use the channel ID, not the channel name.
-
-Ensure you have set up the required integrations:
-
-- [GitHub](https://docs.autokitteh.com/integrations/github)
-- [Google Sheets](https://docs.autokitteh.com/integrations/google)
-- [Slack](https://docs.autokitteh.com/integrations/slack)
-
-### Clone the Repository
-
-```shell
-git clone https://github.com/autokitteh/kittehub.git
-cd kittehub/reviewkitteh
-```
-
-Alternatively, you can copy the individual files in this directory.
-
-### Run the AutoKitteh Server
-
-Simply run this command:
-
-```shell
-ak up --mode dev
-```
-
-### Apply Manifest and Deploy Project
+> Must be a Slack channel ID, not a Slack channel name.
 
-1. Navigate to the `reviewkitteh` directory:
+3. Deploy the project
 
-```shell
-cd reviewkitteh
-```
+## Trigger Workflow
 
-2. Apply manifest and deploy the project by running the following command:
-
-```shell
-ak deploy --manifest autokitteh.yaml --file program.py
-```
-
-The output of this command will be important for initializing connections in the following step if you're using the CLI.
-
-For example, for each configured connection, you will see a line that looks similar to the one below:
-
-```shell
-[exec] create_connection "reviewkitteh/slack_connection": con_01j36p9gj6e2nt87p9vap6rbmz created
-```
-
-`con_01j36p9gj6e2nt87p9vap6rbmz` is the connection ID.
-
-### Initialize Connections
-
-Using the connection IDs from the previous step, run these commands:
-
-```shell
-ak connection init my_github <connection ID>
-ak connection init my_slack <connection ID>
-ak connection init my_googlesheets <connection ID>
-```
+Once deployed, the workflow is triggered by a GitHub pull request event and continues to run, updating Slack until the pull request is closed or merged.
 
-### Trigger the Workflow
+## Self-Hosted Deployment
 
-Once deployed, the workflow is triggered by a GitHub pull request event and continues to run, updating Slack until the pull request is closed or merged.
+Follow these [detailed instructions](https://docs.autokitteh.com/get_started/deployment) to deploy the project on a self-hosted server.
diff --git a/room_reservation/README.md b/room_reservation/README.md
index 3cb8471d..ad1e2ece 100644
--- a/room_reservation/README.md
+++ b/room_reservation/README.md
@@ -52,4 +52,4 @@ The list of meeting rooms is stored in a Google Sheet with the following format:
 
 ## Self-Hosted Deployment
 
-Follow the [detailed instructions](https://docs.autokitteh.com/get_started/deployment) to deploy the project on a self-hosted server.
+Follow these [detailed instructions](https://docs.autokitteh.com/get_started/deployment) to deploy the project on a self-hosted server.