Move old docs, add deprecation notice (#1284)

move v1 docs to mdbook, stub old readmes and point them all in one place

Author: skudasov

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

@@ -136,6 +136,6 @@ jobs:
           goarch: ${{ matrix.goarch }}
           binary_name: ${{ env.PACKAGE_NAME }}
           release_name: ${{ env.PACKAGE_NAME }}
-          release_tag: ${{ env.PACKAGE_NAME}}-${{ env.VERSION }}
+          release_tag: ${{ env.PACKAGE_NAME}}/${{ env.VERSION }}
           project_path: ${{ env.PACKAGE_NAME }}/cmd
           asset_name: ${{ env.PACKAGE_NAME }}-${{ env.VERSION }}-${{ matrix.platform }}-${{ matrix.goarch }}

RELEASE.md

@@ -14,6 +14,7 @@
     - [CLI](./framework/cli.md)
     - [Configuration](./framework/configuration.md)
     - [Test Configuration](./framework/test_configuration_overrides.md)
+    - [Caching](framework/components/caching.md)
     - [Secrets]()
     - [Observability Stack](framework/observability/observability_stack.md)
       - [Metrics]()
@@ -34,16 +35,26 @@
       - [Chainlink]()
       - [RPC]()
       - [Loki]()
+- [Continuous Integration](ci/ci.md)
 - [Libraries](./libraries.md)
   - [Seth](./libs/seth.md)
   - [WASP](./libs/wasp.md)
   - [Havoc](./libs/havoc.md)
+  - [K8s Test Runner](k8s-test-runner/k8s-test-runner.md)
 
 ---
 
 - [Developing](developing.md)
   - [Components](developing/developing_components.md)
 - [Releasing modules](releasing_modules.md)
 
+---
+- [Lib (*Deprecated*)](lib.md)
+    - [Blockchain](lib/blockchain.md)
+    - [Kubernetes](lib/k8s/KUBERNETES.md)
+    - [K8s Remote Run](lib/k8s/REMOTE_RUN.md)
+    - [K8s Tutorial](lib/k8s/TUTORIAL.md)
+    - [Config](lib/config/config.md)
+    - [CRIB Connector](lib/crib.md)
 ---
 - [Build info](build_info.md)

SECRETS.md

@@ -0,0 +1,5 @@
+# Continuous Integration
+
+Here we describe our good practices for structuring different types of tests in Continuous Integration (GitHub Actions).
+
+Follow [this](https://github.com/smartcontractkit/.github/tree/main/.github/workflows) guide.

book/src/SUMMARY.md

@@ -49,11 +49,11 @@ Each component can define inputs and outputs, following these rules:
 
 ### Docker components good practices for [testcontainers-go](https://golang.testcontainers.org/):
 
-An example [simple component](../../../../framework/components/blockchain/anvil.go)
+An example [simple component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/blockchain/anvil.go)
 
-An example of [complex component](../../../../framework/components/clnode/clnode.go)
+An example of [complex component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/clnode/clnode.go)
 
-An example of [composite component](../../../../framework/components/simple_node_set/node_set.go)
+An example of [composite component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/simple_node_set/node_set.go)
 
 - Inputs should include at least `image`, `tag` and `pull_image` field
 ```golang

book/src/ci/ci.md

@@ -2,9 +2,9 @@
 
 We use component caching to accelerate test development and enforce idempotent test actions.
 
-Each component is designed to be pure with defined inputs/outputs.
+Each component is isolated by means of inputs and outputs.
 
-You can use an environment variable to skip deployment steps and use cached outputs if your infrastructure is already running (locally or remotely):
+If cached config has any outputs with `use_cache = true` it will be used instead of deploying a component again.
 
 ```
 export CTF_CONFIGS=smoke-cache.toml
@@ -26,4 +26,4 @@ http_url = 'http://127.0.0.1:33447'
 docker_internal_ws_url = 'ws://anvil-3716a:8900'
 docker_internal_http_url = 'http://anvil-3716a:8900'
 ```
-Set flag `use_cache = true` on any component output and run your test again
+Set flag `use_cache = true` on any component output, change output fields as needed and run your test again.

book/src/developing/developing_components.md

@@ -2,10 +2,11 @@
 
 To start writing tests create a directory for your project with `go.mod` and pull the framework
 ```
-go get github.com/smartcontractkit/chainlink-testing-framework/framework@ac819d889f97e0f5c04aee3212454ad1f8b6f4ef
+go get github.com/smartcontractkit/chainlink-testing-framework/framework
 ```
 
 Then download the CLI (runs from directory where you have `go.mod`)
+Make sure you have your GOPATH set: `export GOPATH=$HOME/go && export PATH=$PATH:$GOPATH/bin`
 ```
 go get github.com/smartcontractkit/chainlink-testing-framework/framework/cmd && \
 go install github.com/smartcontractkit/chainlink-testing-framework/framework/cmd && \

book/src/framework/components/caching.md

@@ -16,8 +16,6 @@ Create a configuration file `smoke.toml`
   port = "8545"
   type = "anvil"
 
-[contracts]
-
 [data_provider]
   port = 9111
 

book/src/framework/getting_started.md

@@ -85,13 +85,9 @@ package capabilities_test
 import (
 	"fmt"
 	"github.com/smartcontractkit/chainlink-testing-framework/framework"
-	"github.com/smartcontractkit/chainlink-testing-framework/framework/clclient"
 	"github.com/smartcontractkit/chainlink-testing-framework/framework/components/blockchain"
 	"github.com/smartcontractkit/chainlink-testing-framework/framework/components/fake"
 	ns "github.com/smartcontractkit/chainlink-testing-framework/framework/components/simple_node_set"
-	"github.com/smartcontractkit/chainlink-testing-framework/seth"
-	burn_mint_erc677 "github.com/smartcontractkit/chainlink/e2e/capabilities/components/gethwrappers"
-	"github.com/smartcontractkit/chainlink/e2e/capabilities/components/onchain"
 	"github.com/stretchr/testify/require"
 	"os"
 	"testing"