From e7813ac92a9781ab74fe420a3bcbe0fc2bb2397e Mon Sep 17 00:00:00 2001 From: Dr K Murphy Date: Wed, 17 Apr 2024 14:31:34 +0200 Subject: [PATCH 1/2] add updates --- docs/index.md | 13 +++++++++++-- docs/quickstart/breakdown-deployment.md | 4 ++++ docs/quickstart/deploy-stack.md | 4 ++++ docs/quickstart/observability.md | 4 ++++ docs/quickstart/set-up-node.md | 4 ++++ docs/quickstart/zkevm-cache-contracts.md | 4 ++++ 6 files changed, 31 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index c95942dc..2e26e996 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,11 +1,18 @@ --- +comments: true hide: - toc --- # Overview -The architectural diagram below shows how CDK stack components may interact with each other and a layer 1 blockchain. +Kurtosis is a developer platform that allows you to package and launch a backend stack with becoming overburdened with configuration details. + +The Polygon developer team have implemented a Kurtosis build for the CDK stack which includes all zkEVM node components, all services, and a validium option also. +s +## CDK architecture + +The diagram below shows how CDK stack components may interact with each other and with a layer 1 blockchain.
@@ -13,7 +20,9 @@ The architectural diagram below shows how CDK stack components may interact with
-The [quick start documents](quickstart/deploy-stack.md) show you how to deploy a private, portable, and modular Polygon CDK developer stack with [Kurtosis](https://github.com/kurtosis-tech/kurtosis). +## Get started + +The [quick start documents](quickstart/deploy-stack.md) show you how to deploy a private, portable, and modular Polygon CDK developer stack on [Kurtosis](https://github.com/kurtosis-tech/kurtosis). The deployment document is aimed at users and developers who do not necessarily want to run the latest CDK versions, or follow the full tutorials, and are happy to play around with an experimental set up. diff --git a/docs/quickstart/breakdown-deployment.md b/docs/quickstart/breakdown-deployment.md index 69702de4..deb6c169 100644 --- a/docs/quickstart/breakdown-deployment.md +++ b/docs/quickstart/breakdown-deployment.md @@ -1,3 +1,7 @@ +--- +comments: true +--- + Rather than executing the deployment process as a monolithic operation, you can break it down into stages and run each stage separately. ### Enable or disable stages diff --git a/docs/quickstart/deploy-stack.md b/docs/quickstart/deploy-stack.md index 8ecfea32..e1ee5481 100644 --- a/docs/quickstart/deploy-stack.md +++ b/docs/quickstart/deploy-stack.md @@ -1,3 +1,7 @@ +--- +comments: true +--- + ## Hardware requirements - A Linux-based OS (e.g., Ubuntu Server 22.04 LTS). diff --git a/docs/quickstart/observability.md b/docs/quickstart/observability.md index b51ecda9..f78c62da 100644 --- a/docs/quickstart/observability.md +++ b/docs/quickstart/observability.md @@ -1,3 +1,7 @@ +--- +comments: true +--- + The `kurtosis-cdk` stack deploys Prometheus, Grafana, and Panoptichain to help observe the network. These are enabled by default, but can be turned off by setting the `deploy_observability` to false in the `params.yml`. Find the dashboard details by running: `kurtosis enclave inspect cdk-v1` diff --git a/docs/quickstart/set-up-node.md b/docs/quickstart/set-up-node.md index 41bcbb18..9589cac1 100644 --- a/docs/quickstart/set-up-node.md +++ b/docs/quickstart/set-up-node.md @@ -1,3 +1,7 @@ +--- +comments: true +--- + In addition to the core stack, you can also attach and synchronize a permissionless node. ## Prerequisites diff --git a/docs/quickstart/zkevm-cache-contracts.md b/docs/quickstart/zkevm-cache-contracts.md index add6a092..8f76d4f6 100644 --- a/docs/quickstart/zkevm-cache-contracts.md +++ b/docs/quickstart/zkevm-cache-contracts.md @@ -1,3 +1,7 @@ +--- +comments: true +--- + We manually build zkEVM contracts images to make the deployment of the Kurtosis package as fast as possible. Indeed, most of the deployment time is spent downloading npm dependencies and compiling the zkEVM contracts. From 869cd14b7322cce57430883caf74031c303def2e Mon Sep 17 00:00:00 2001 From: Dr K Murphy Date: Wed, 17 Apr 2024 14:38:06 +0200 Subject: [PATCH 2/2] typo --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 2e26e996..e6c2c50a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,7 +6,7 @@ hide: # Overview -Kurtosis is a developer platform that allows you to package and launch a backend stack with becoming overburdened with configuration details. +Kurtosis is a developer platform that allows you to package and launch a backend stack without becoming overburdened with configuration details. The Polygon developer team have implemented a Kurtosis build for the CDK stack which includes all zkEVM node components, all services, and a validium option also. s