Merge pull request #301 from pactflow/docs/ai_install_instruction_tweaks

docs: update pactflow-ai install instructions / add interactive tutorial
pactflow · Sep 12, 2024 · a44e5ab · a44e5ab
2 parents 229d7c2 + 4e3858d
commit a44e5ab
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 3 deletions.
diff --git a/website/docs/docs/ai/index.md b/website/docs/docs/ai/index.md
@@ -25,12 +25,29 @@ This setting is only available in the new user interface.
 
 ## Installation
 
-For *nix users (including Windows users running WSL), use the following command to download and install:
+For *nix users (including Windows users running WSL/msys2/mingw), use the following command to download and install:
 
+```sh
+curl https://download.pactflow.io/ai/get.sh | sh
 ```
-curl https://download.pactflow.io/ai/get.sh  | sh
+
+### Installation Options
+
+There are some options which you can set during installation.
+
+For a full list, see the `--help`/`-h` command
+
+```sh
+curl https://download.pactflow.io/ai/get.sh | sh -s -- -h
 ```
 
+- `--verbose` / `-v` / `PACTFLOW_AI_VERBOSE`: Enable verbose output
+- `--quiet` / `-q` / `PACTFLOW_AI_QUIET`: Disable progress output
+- `--yes` / `-y` / `PACTFLOW_AI_YES`: Disable confirmation prompt and assume 'yes'
+- `--destination` / `-d` / `PACTFLOW_AI_DESTINATION`: Specify the directory to install the binary
+- `--default-host` / `PACTFLOW_AI_DEFAULT_HOST`: Choose a default host triple rather than autodetecting
+- `--no-modify-path` / `PACTFLOW_AI_NO_MODIFY_PATH`: Don't configure the PATH environment variable
+
 Verify the installation by running `pactflow-ai` to ensure it executes successfully.
 
 ### Manual installation
@@ -39,6 +56,12 @@ Alternatively, download the latest version for your OS and architecture from the
 
 <AiDownloadTable />
 
+:::note
+Linux GNU users will require glibc version 2.23 or later.
+
+Environments which do not use glibc, or use a version of glibc prior to 2.23, should instead use the musl variant.
+:::
+
 ## Usage
 
 Running `pactflow-ai --help` will show detailed usage for any subcommands.
@@ -112,4 +135,8 @@ The limits and your usage against these limits are not currently visible on the
 
 ## Getting help and providing feedback
 
-For feedback, feature requests, or assistance with the tool, join our [slack channel](https://pact-foundation.slack.com/archives/C07K2FT0XKK) or speak directly with your Account Manager. For general support, please follow the [usual methods](https://support.smartbear.com/pactflow/message/).
+For feedback, feature requests, or assistance with the tool, join our [slack channel](https://pact-foundation.slack.com/archives/C07K2FT0XKK) or speak directly with your Account Manager. For general support, please follow the [usual methods](https://support.smartbear.com/pactflow/message/).
+
+## Tutorials
+
+We've created an [in-browser tutorial](https://docs.pactflow.io/docs/tutorials#getting-started-with-pactflow-ai) to help you get started with PactFlow AI, and see it in action against a JavaScript codebase.
diff --git a/website/docs/docs/tutorials.md b/website/docs/docs/tutorials.md
@@ -44,6 +44,34 @@ You will:
 | Node JS  | <https://killercoda.com/pactflow/scenario/pactflow-getting-started-js>   |
 | Java     | <https://killercoda.com/pactflow/scenario/pactflow-getting-started-java> |
 
+## Getting Started with PactFlow AI
+
+_Level: Beginner_
+
+In this tutorial, we guide you through creating a consumer Pact test with the help of PactFlow AI
+
+You will download and setup the PactFlow AI CLI tool, and generate consumer Pact tests for
+a JavaScript codebase.
+
+To read more about our [PactFlow AI feature](https://pactflow.io/ai/), check out our documentation [here](https://docs.pactflow.io/docs/ai)
+
+### Goals
+
+Ultimately, our goal is to get you up and integrated with PactFlow AI as quickly as possible!
+
+You will:
+
+1. Learn how to install the PactFlow AI CLI tool (`pactflow-ai`).
+2. How to authenticate with PactFlow AI and your PactFlow account
+3. Get hands-on experience with all current modes of consumer Pact test generation with PactFlow AI
+4. See how PactFlow AI fits into the picture so that you can get up and running quickly.
+
+### Tutorial
+
+| Language | Link                                                                   |
+| -------- | ---------------------------------------------------------------------- |
+| Node JS  | <https://killercoda.com/pactflow/scenario/pactflow-ai>   |
+
 ## Gating deployments with PactFlow
 
 _Level: Intermediate_