change binary name

Author: skudasov

.github/workflows/docs.yml

@@ -3,8 +3,8 @@ name: GH Pages Deploy (Docs, mdbook)
 
 on:
   push:
-#    branches:
-#      - main
+    branches:
+      - main
 
 jobs:
   build-deploy:

.github/workflows/release-go-module.yml

@@ -126,6 +126,11 @@ jobs:
           else
             echo "CMD_ENTRYPOINT_EXISTS=false" >> "$GITHUB_ENV"
           fi
+      - name: Set the name for external CLI
+        run: |
+          if [ "${{ env.PACKAGE_NAME }}" == "framework" ]; then
+            echo "PACKAGE_NAME=ctf" >> $GITHUB_ENV
+          fi
       - name: Build binary release
         uses: wangyoucao577/go-release-action@v1
         if: env.CMD_ENTRYPOINT_EXISTS == 'true'

book/src/framework/first_test.md

@@ -41,9 +41,14 @@ func TestMe(t *testing.T) {
 }
 ```
 
-Select your configuration by setting `CTF_CONFIGS=smoke.toml` and run it
+Run the test
 ```bash
-go test -v -run TestMe
+CTF_CONFIGS=smoke.toml go test -v -run TestMe
+```
+
+Remove containers
+```
+ctf d rm
 ```
 
 Summary:

book/src/framework/getting_started.md

@@ -1,7 +1,7 @@
-# Getting started
+# 🚀 Getting started
 
 ## Prerequisites
-- `Docker` ([OrbStack](https://orbstack.dev/) or [Docker Desktop](https://www.docker.com/products/docker-desktop/))
+- `Docker` [OrbStack](https://orbstack.dev/) or [Docker Desktop](https://www.docker.com/products/docker-desktop/), we recommend OrbStack (faster, smaller memory footprint)
 - [Golang](https://go.dev/doc/install)
 
 ## Test setup
@@ -11,18 +11,19 @@ To start writing tests create a directory for your project with `go.mod` and pul
 go get github.com/smartcontractkit/chainlink-testing-framework/framework
 ```
 
-Then download the CLI (runs from directory where you have `go.mod`)
+Then download the CLI (runs from the directory where you have `go.mod`)
 ```
 go get github.com/smartcontractkit/chainlink-testing-framework/framework/cmd && \
 go install github.com/smartcontractkit/chainlink-testing-framework/framework/cmd && \
 mv ~/go/bin/cmd ~/go/bin/ctf
 ```
+Or download a binary release [here](https://github.com/smartcontractkit/chainlink-testing-framework/releases/tag/framework%2Fv0.1.7) and rename it to `ctf`
+
 More CLI [docs](./cli.md)
 
-Create an `.envrc` file and put common parameters there (you can use [direnv](https://direnv.net/) to sync them more easily)
+Create an `.envrc` file and do `source .envrc`
 ```
 export TESTCONTAINERS_RYUK_DISABLED=true # do not remove containers while we develop locally
-export CTF_CONFIGS=smoke.toml            # our configuration file
 ```
 
 Now you are ready to write your [first test](./first_test.md)
@@ -35,8 +36,10 @@ Spin up your local obserability stack (Grafana LGTM)
 ```
 ctf obs up
 ```
+More [docs](observability/observability_stack.md)
 
 Spin up your `Blockscout` stack
 ```
 ctf bs up
 ```
+More [docs](observability/blockscout.md)

book/src/framework/nodeset_capabilities.md

@@ -2,6 +2,12 @@
 
 Let's use some external capability binaries in our tests and extend the [previous one](nodeset_environment.md).
 
+We'll use a private repository example, so you should be authorized with [gh]()
+```
+gh auth login
+gh auth setup-git
+```
+
 Download an example capability binary
 ```
 export export GOPRIVATE=github.com/smartcontractkit/capabilities
@@ -41,7 +47,7 @@ Create a configuration file `smoke.toml`
 
 Run it
 ```bash
-go test -v -run TestNodeSet
+CTF_CONFIGS=smoke.toml go test -v -run TestNodeSet
 ```
 
 Now you can configure your capability using `clclient.CreateJobRaw($raw_toml)`.

book/src/framework/nodeset_compatibility.md

@@ -82,7 +82,7 @@ You can reuse `smoke_test.go` from previous [setup](nodeset_environment.md)
 
 Run it
 ```bash
-go test -v -run TestNodeSet
+CTF_CONFIGS=smoke.toml go test -v -run TestNodeSet
 ```
 
 Summary:

book/src/framework/nodeset_environment.md

@@ -69,7 +69,7 @@ func TestNodeSet(t *testing.T) {
 
 Run it
 ```bash
-go test -v -run TestNodeSet
+CTF_CONFIGS=smoke.toml go test -v -run TestNodeSet
 ```
 
 You'll see something like, use any URL to access CL node

book/src/framework/nodeset_external.md

@@ -28,7 +28,7 @@ export CTF_CONFIGS=smoke.toml,smoke-fuji.toml
 
 Run it
 ```bash
-go test -v -run TestNodeSet
+CTF_CONFIGS=smoke.toml go test -v -run TestNodeSet
 ```
 
 Summary: