From 62bab06fbed359c06fa945a7db8687f16badaebc Mon Sep 17 00:00:00 2001 From: Yousaf Nabi Date: Thu, 12 Sep 2024 18:46:36 +0100 Subject: [PATCH 1/2] docs(ai): add in-browser tutorial and updated docs --- website/docs/docs/ai/index.md | 33 ++++++++++++++++++++++++++++++--- website/docs/docs/tutorials.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+), 3 deletions(-) diff --git a/website/docs/docs/ai/index.md b/website/docs/docs/ai/index.md index 5d69bb92..92fa9b47 100644 --- 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 +:::note +Linux gnu users will require glibc version 2.23 or later. + +For users in distros which a glibc version <2.23 (check by running `ldd --version`), you can download and use the linux musl variant instead. +::: + ## 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/). \ No newline at end of file +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 index a3676dcb..1f60fdff 100644 --- a/website/docs/docs/tutorials.md +++ b/website/docs/docs/tutorials.md @@ -44,6 +44,34 @@ You will: | Node JS | | | 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 | | + ## Gating deployments with PactFlow _Level: Intermediate_ From 4e3858d3851a6ebf9dc663ca1105da579ef2dca2 Mon Sep 17 00:00:00 2001 From: Matt Fellows <53900+mefellows@users.noreply.github.com> Date: Fri, 13 Sep 2024 08:31:56 +1000 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: JP-Ellis --- website/docs/docs/ai/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/docs/ai/index.md b/website/docs/docs/ai/index.md index 92fa9b47..ae5ab023 100644 --- a/website/docs/docs/ai/index.md +++ b/website/docs/docs/ai/index.md @@ -57,9 +57,9 @@ Alternatively, download the latest version for your OS and architecture from the :::note -Linux gnu users will require glibc version 2.23 or later. +Linux GNU users will require glibc version 2.23 or later. -For users in distros which a glibc version <2.23 (check by running `ldd --version`), you can download and use the linux musl variant instead. +Environments which do not use glibc, or use a version of glibc prior to 2.23, should instead use the musl variant. ::: ## Usage