From 6eb4d1719a0ba0df675899c9a70bc18bf286ff07 Mon Sep 17 00:00:00 2001
From: Navarone Feekery <13634519+navarone-feekery@users.noreply.github.com>
Date: Thu, 16 Jan 2025 15:24:35 +0100
Subject: [PATCH] Update docs (#3114)

---
 docs/CLI.md               | 22 +++++++++++-----------
 docs/DEVELOPING.md        |  2 +-
 scripts/testing/README.md | 10 +++++-----
 3 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/docs/CLI.md b/docs/CLI.md
index e6a0c7fdc..fc4022b03 100644
--- a/docs/CLI.md
+++ b/docs/CLI.md
@@ -16,23 +16,23 @@ Connectors CLI helps with Elastic Connectors managing connectors and running syn
 ## Installation
 1. Clone the repository `git clone https://github.com/elastic/connectors.git`
 2. Run `make clean install` to install dependencies and create executable files.
-3. Connectors CLI is available via `./bin/connectors`
+3. Connectors CLI is available via `.venv/bin/connectors`
 
 ## Configuration
 **Note:** Make sure your Elasticsearch instance is up and running.
 
-1. Run `./bin/connectors login` to authenticate the CLI with an Elasticsearch instance.
+1. Run `.venv/bin/connectors login` to authenticate the CLI with an Elasticsearch instance.
 2. Provide credentials
 3. The command will create or ask to rewrite an existing configuration file in `./cli/config.yml`
 
 By default, the CLI uses basic authentication method (username, password) however an API key can be used too. 
-Run `./bin/connectors login --method apikey` to authenticate the CLI via your API key. 
+Run `.venv/bin/connectors login --method apikey` to authenticate the CLI via your API key. 
 
 When you run any command you can specify a configuration file using `-c` argument.
 Example:
 
 ```bash
-./bin/connectors -c <config-file-path.yml> connector list
+.venv/bin/connectors -c <config-file-path.yml> connector list
 ```
 
 ## Available commands
@@ -41,7 +41,7 @@ Connectors CLI provides a `--help`/`-h` argument that can be used with any comma
 
 For example:
 ```bash
-./bin/connectors --help
+.venv/bin/connectors --help
 
 
 Usage: connectors [OPTIONS] COMMAND [ARGS]...
@@ -76,7 +76,7 @@ To bypass interactive mode you can use the `--from-file` argument, pointing to a
 Examples:
 
 ```console
-./bin/connectors connector create \
+.venv/bin/connectors connector create \
   --index-name my-index \
   --service-type sharepoint_online \
   --index-language en \
@@ -95,7 +95,7 @@ Lists all the existing connectors
 Examples:
 
 ```console
-./bin/connectors connector list
+.venv/bin/connectors connector list
 ```
 
 This will display all existing connectors and the associated indices.
@@ -105,7 +105,7 @@ Lists all jobs and their stats.
 
 Examples
 ```console
-./bin/connectors job list -- <connector_id>
+.venv/bin/connectors job list -- <connector_id>
 ```
 
 This will display all sync jobs including information like job status, number of indexed documents and index data volume associated with `connector_id`.
@@ -116,7 +116,7 @@ Marks the job as `cancelling` to let Connector services know that the job has to
 Examples:
 
 ```console
-./bin/connectors job cancel -- <job_id>
+.venv/bin/connectors job cancel -- <job_id>
 ```
 
 #### `connectors job start`
@@ -125,7 +125,7 @@ Schedules a new sync job and lets Connector service pick it up.
 Examples:
 
 ```console
-./bin/connectors job start -- \
+.venv/bin/connectors job start -- \
   -i <connector_id> \
   -t <job_type{full,incremental,access_control}> \
   -o <format{text,json}>
@@ -139,7 +139,7 @@ Shows information about a sync job.
 Examples:
 
 ```console
-./bin/connectors job view -- <job_id> -o <format{text,json}
+.venv/bin/connectors job view -- <job_id> -o <format{text,json}
 ```
 
 This will display information about the job including job id, connector id, indexed document counts and index data value.
diff --git a/docs/DEVELOPING.md b/docs/DEVELOPING.md
index 9bfc7eb05..4bec776b1 100644
--- a/docs/DEVELOPING.md
+++ b/docs/DEVELOPING.md
@@ -38,7 +38,7 @@ $ make clean install
 The `elastic-ingest` CLI will be installed on your system:
 
 ```shell
-$ bin/elastic-ingest --help
+$ .venv/bin/elastic-ingest --help
 usage: elastic-ingest [-h] [--action {poll,list}] [-c CONFIG_FILE] [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL} | --debug] [--filebeat] [--version] [--uvloop]
 
 options:
diff --git a/scripts/testing/README.md b/scripts/testing/README.md
index d1d4fb612..e6bf6b79b 100644
--- a/scripts/testing/README.md
+++ b/scripts/testing/README.md
@@ -19,18 +19,18 @@ Run `make clean install` to generate executable files in `./bin` folder
 
 ### Usage
 
-Run `./bin/test-connectors --help` or `./bin/test-connectors {command name} --help` to get more information about the cli. 
+Run `.venv/bin/test-connectors --help` or `.venv/bin/test-connectors {command name} --help` to get more information about the cli. 
 
 #### Running test with Elastic cloud deployment
 If you want to run your test suite using a cloud Elasticsearch deployment follow the next steps: 
 1. Create a cloud deployment
 2. Download a credentials file (or create a new user)
-3. Run `./bin/test-connectors run-test my-testing-environment-name --es-host {host} --es-username {user name} --es-password {password} --test-case {path to the test case file}`
+3. Run `.venv/bin/test-connectors run-test my-testing-environment-name --es-host {host} --es-username {user name} --es-password {password} --test-case {path to the test case file}`
 
 #### Running test with local Elasticsearch
 If you want to run your tests with local Elasticsearch you need to specify `--es-version` option. Like
 
-`./bin/test-connectors run-test my-testing-environment-name --es-version 8.12-SNAPSHOT --test-case {path to the test case file}`
+`.venv/bin/test-connectors run-test my-testing-environment-name --es-version 8.12-SNAPSHOT --test-case {path to the test case file}`
 
 In this case, the cli will deploy an Elasticsearch instance in the same VM where the connector service will be running. 
 
@@ -38,7 +38,7 @@ In this case, the cli will deploy an Elasticsearch instance in the same VM where
 
 You can use any git reference such as commit sha, a tag, or a branch name. The cli will pull the defined git reference and run `make clean install`. 
 
-Example: `./bin/test-connectors run-test my-testing-environment-name --es-version 8.12-SNAPSHOT --connectors-ref 8.12 --test-case {path to the test case file}`
+Example: `.venv/bin/test-connectors run-test my-testing-environment-name --es-version 8.12-SNAPSHOT --connectors-ref 8.12 --test-case {path to the test case file}`
 
 #### Keeping your VM running when the tests passed
 Sometimes it's useful to get access to the logs or make some changes in the code and run tests again. The CLI will print a list of useful commands you can use to access the VM resources like: 
@@ -47,7 +47,7 @@ Sometimes it's useful to get access to the logs or make some changes in the code
 
 To automatically delete the VM you need to use `--delete` option. 
 
-`./bin/test-connectors run-test my-testing-environment-name --es-version 8.12-SNAPSHOT --connectors-ref 8.12 --test-case {path to the test case file} --delete`
+`.venv/bin/test-connectors run-test my-testing-environment-name --es-version 8.12-SNAPSHOT --connectors-ref 8.12 --test-case {path to the test case file} --delete`
 
 #### Using different machine type
 All new VMs are based on a predefined image which is in turn based on `ubuntu-2204-lts` with python3 and docker installed. Custome images are not supported. You can change a machine type by providing `--vm-type`. Visit [the official GCP documentation](https://cloud.google.com/compute/docs/general-purpose-machines) to get more information.