Merge branch 'main' into hendrikebbers-patch-1

Author: jwagantall

.github/workflows/flow-hugo-publish.yaml

@@ -70,7 +70,8 @@ jobs:
       - name: Setup Hugo
         uses: step-security/actions-hugo@b99dc9a4cddce1866ff2c3682c01aeb27b4d91f0 # v3.0.1
         with:
-          hugo-version: '0.124.1'
+          hugo-version: '0.145.0'
+          extended: true
 
       - name: Checkout Code
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
@@ -94,11 +95,16 @@ jobs:
           version: 3.39.2
           repo-token: ${{ secrets.GITHUB_TOKEN }}
 
+      - name: Setup Go
+        uses: actions/setup-go@d35c59abb061a4a6fb18e82ac0862c26744d6ab5 # pinned to v5.5.0
+        with:
+          go-version-file: 'docs/site/go.mod'
+
       - name: Build with Hugo
         run: |
           set -xeo pipefail
           cd docs/site
-          task default
+          task build
 
       # Upload the built site to GitHub Pages
       - name: Upload Pages Artifact

.github/workflows/flow-task-test.yaml

@@ -75,7 +75,7 @@ jobs:
 
       - name: Run Example Task File Test with type ${{ matrix.type }}
         run: |
-          cd examples/external-database-test
           export CONSENSUS_NODE_VERSION=$(grep 'HEDERA_PLATFORM_VERSION' version.ts | sed -E "s/.*'([^']+)';/\1/")
+          cd examples/external-database-test
           SOLO_CLUSTER_NAME=solo-task-test-${{ matrix.type }}-${{ github.run_id }}-${{ github.run_attempt }} task install:external-database
           task destroy:external-database

.github/workflows/script/gcs_test.sh

@@ -131,7 +131,7 @@ else
   npm run solo-test -- init
   npm run solo-test -- cluster-ref setup \
     -s "${SOLO_CLUSTER_SETUP_NAMESPACE}"
-  npm run solo-test -- cluster-ref connect --cluster-ref kind-${SOLO_CLUSTER_NAME} --context kind-${SOLO_CLUSTER_NAME} --email [email protected]
+  npm run solo-test -- cluster-ref connect --cluster-ref kind-${SOLO_CLUSTER_NAME} --context kind-${SOLO_CLUSTER_NAME}
 
   npm run solo-test -- deployment create -n "${SOLO_NAMESPACE}" --deployment "${SOLO_DEPLOYMENT}"
 
@@ -155,18 +155,18 @@ else
   kubectl port-forward -n "${SOLO_NAMESPACE}" svc/mirror-rest 5551:80 > /dev/null 2>&1 &
 
   npm run solo-test -- explorer deploy -s "${SOLO_CLUSTER_SETUP_NAMESPACE}" --deployment "${SOLO_DEPLOYMENT}" \
-    --cluster-ref kind-${SOLO_CLUSTER_NAME} --tls-cluster-issuer-type self-signed --enable-hedera-explorer-tls \
+    --cluster-ref kind-${SOLO_CLUSTER_NAME} --tls-cluster-issuer-type self-signed --enable-explorer-tls \
     --ingress-controller-value-file "${script_dir}"/explorer-ingress-controller-values.yaml \
     --enable-ingress --domain-name localhost
 
   kubectl port-forward -n "${SOLO_NAMESPACE}" svc/haproxy-node1-svc 50211:50211 > /dev/null 2>&1 &
 
-  explorer_svc="$(kubectl get svc -l app.kubernetes.io/component=hedera-explorer -n ${SOLO_NAMESPACE} --output json | jq -r '.items[].metadata.name')"
+  explorer_svc="$(kubectl get svc -l app.kubernetes.io/component=hiero-explorer -n ${SOLO_NAMESPACE} --output json | jq -r '.items[].metadata.name')"
   kubectl port-forward -n "${SOLO_NAMESPACE}" svc/"${explorer_svc}" 8080:80 > /dev/null 2>&1 &
 
   # Check Explorer endpoints
-  check_service_health "https://localhost:31001" "Hedera Mirror Node Explorer" "Explorer" "https" || exit 1
-  check_service_health "http://localhost:31000" "Hedera Mirror Node Explorer" "Explorer" "http" || exit 1
+  check_service_health "https://localhost:31001" "SPDX-License" "Explorer" "https" || exit 1
+  check_service_health "http://localhost:31000" "SPDX-License" "Explorer" "http" || exit 1
 
   # Check Mirror API endpoints
   check_service_health "https://localhost:32001/api/v1/accounts" "accounts" "Mirror" "https" || exit 1

.github/workflows/script/update_md.sh

@@ -1,19 +1,22 @@
 #!/bin/bash
 
 # This script is used to run some common solo commands, and use the output to update
-# the docs/content/User/StepByStepGuide.md file. This is useful to keep the guide up to date
+# the docs/site/content/en/docs/step-by-step-guide.md file. This is useful to keep the guide up to date
 
 set -xeo pipefail
 
+export TARGET_DIR=docs/site/content/en/docs
+export TARGET_FILE=${TARGET_DIR}/step-by-step-guide.md
+
 if [[ -z "${SOLO_TEST_CLUSTER}" && ${SOLO_CLUSTER_NAME} == "" ]]; then
   SOLO_CLUSTER_NAME=solo-e2e
 else
   SOLO_CLUSTER_NAME=${SOLO_TEST_CLUSTER}
 fi
 
-export SOLO_NAMESPACE=solo
+export SOLO_NAMESPACE=solo-e2e
+export SOLO_CLUSTER_SETUP_NAMESPACE=solo-cluster-setup
 export SOLO_DEPLOYMENT=solo-deployment
-export SOLO_CLUSTER_SETUP_NAMESPACE=solo-cluster
 export [email protected]
 
 echo "Perform the following kind and solo commands and save output to environment variables"
@@ -24,7 +27,7 @@ export KIND_CREATE_CLUSTER_OUTPUT=$( cat create-cluster.log | tee test.log )
 solo init | tee init.log
 export SOLO_INIT_OUTPUT=$( cat init.log | tee test.log )
 
-solo cluster-ref connect --cluster-ref kind-${SOLO_CLUSTER_NAME} --context kind-${SOLO_CLUSTER_NAME} --email "${SOLO_EMAIL}" | tee cluster-ref-connect.log
+solo cluster-ref connect --cluster-ref kind-${SOLO_CLUSTER_NAME} --context kind-${SOLO_CLUSTER_NAME} | tee cluster-ref-connect.log
 export SOLO_CLUSTER_REF_CONNECT_OUTPUT=$( cat cluster-ref-connect.log | tee test.log )
 
 solo deployment create -n "${SOLO_NAMESPACE}" --deployment "${SOLO_DEPLOYMENT}" | tee deployment-create.log
@@ -54,7 +57,7 @@ export SOLO_MIRROR_NODE_DEPLOY_OUTPUT=$( cat mirror-node-deploy.log | tee test.l
 solo relay deploy -i node1,node2,node3 --deployment "${SOLO_DEPLOYMENT}" | tee relay-deploy.log
 export SOLO_RELAY_DEPLOY_OUTPUT=$( cat relay-deploy.log | tee test.log )
 
-solo explorer deploy --deployment "${SOLO_DEPLOYMENT}" -q | tee explorer-deploy.log
+solo explorer deploy --deployment "${SOLO_DEPLOYMENT}" --cluster-ref kind-${SOLO_CLUSTER_NAME} -q | tee explorer-deploy.log
 export SOLO_EXPLORER_DEPLOY_OUTPUT=$( cat explorer-deploy.log | tee test.log )
 
 solo relay destroy -i node1,node2,node3 --deployment "${SOLO_DEPLOYMENT}" | tee relay-destroy.log
@@ -69,19 +72,22 @@ export SOLO_EXPLORER_DESTROY_OUTPUT=$( cat explorer-destroy.log | tee test.log )
 solo network destroy --deployment "${SOLO_DEPLOYMENT}" --force -q | tee network-destroy.log
 export SOLO_NETWORK_DESTROY_OUTPUT=$( cat network-destroy.log | tee test.log )
 
-cd ../
-echo "Generate README.md"
+pushd ../
+echo "Generating ${TARGET_FILE} from ${TARGET_FILE}.template"
 
 envsubst '$KIND_CREATE_CLUSTER_OUTPUT,$SOLO_INIT_OUTPUT,$SOLO_NODE_KEY_PEM_OUTPUT,$SOLO_CLUSTER_SETUP_OUTPUT, \
 $SOLO_DEPLOYMENT_CREATE_OUTPUT,$SOLO_NETWORK_DEPLOY_OUTPUT,$SOLO_NODE_SETUP_OUTPUT,$SOLO_NODE_START_OUTPUT,\
 $SOLO_MIRROR_NODE_DEPLOY_OUTPUT,$SOLO_RELAY_DEPLOY_OUTPUT,$SOLO_CLUSTER_REF_CONNECT_OUTPUT,$SOLO_DEPLOYMENT_ADD_CLUSTER_OUTPUT,\
 $SOLO_EXPLORER_DEPLOY_OUTPUT,$SOLO_RELAY_DESTROY_OUTPUT,$SOLO_MIRROR_NODE_DESTROY_OUTPUT,$SOLO_EXPLORER_DESTROY_OUTPUT,$SOLO_NETWORK_DESTROY_OUTPUT'\
-< docs/site/content/User/StepByStepGuide.md.template > docs/site/content/User/StepByStepGuide.md
+< ${TARGET_FILE}.template > ${TARGET_FILE}
 
 echo "Remove color codes and lines showing intermediate progress"
 
-sed -i 's/\[32m//g' docs/site/content/User/StepByStepGuide.md
-sed -i 's/\[33m//g' docs/site/content/User/StepByStepGuide.md
-sed -i 's/\[39m//g' docs/site/content/User/StepByStepGuide.md
-egrep -v '↓|❯|•' docs/site/content/User/StepByStepGuide.md > docs/site/content/User/StepByStepGuide.md.tmp && mv docs/site/content/User/StepByStepGuide.md.tmp docs/site/content/User/StepByStepGuide.md
+sed -i 's/\[32m//g' ${TARGET_FILE}
+sed -i 's/\[33m//g' ${TARGET_FILE}
+sed -i 's/\[39m//g' ${TARGET_FILE}
+egrep -v '↓|❯|•' ${TARGET_FILE} > ${TARGET_FILE}.tmp && mv ${TARGET_FILE}.tmp ${TARGET_FILE}
+
+popd
+rm *.log
 set +x

.github/workflows/zxc-code-analysis.yaml

@@ -412,7 +412,7 @@ jobs:
           path: 'coverage/${{ inputs.e2e-relay-test-subdir }}'
 
       - name: Download E2E Block Node Coverage Report
-        uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e # v4.2.1
+        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
         if: ${{ (inputs.enable-codecov-analysis || inputs.enable-codacy-coverage) && inputs.enable-e2e-coverage-report && !cancelled() && !failure() }}
         with:
           name: ${{ inputs.e2e-block-node-coverage-report }}

.github/workflows/zxc-update-readme.yaml

@@ -16,12 +16,12 @@
 
 name: Update README.md
 
-# This workflow calls script update_md.sh to update the docs/content/User/StepByStepGuide.md file
+# This workflow calls script update_md.sh to update the docs/site/content/en/docs/step-by-step-guide.md file
 on:
   workflow_dispatch:
     inputs:
       commit-changes:
-        description: "Commit updated README.md"
+        description: "Commit updated step-by-step-guide.md"
         type: boolean
         required: false
         default: false
@@ -42,7 +42,7 @@ on:
         required: true
     inputs:
       commit-changes:
-        description: "Commit updated README.md"
+        description: "Commit updated step-by-step-guide.md"
         type: boolean
         required: false
         default: false
@@ -52,7 +52,7 @@ on:
         required: false
     outputs:
       commit-hash:
-        description: "The commit hash for the updated README.md commit"
+        description: "The commit hash for the updated step-by-step-guide.md commit"
         value: ${{ jobs.update.outputs.commit_hash }}
 
 defaults:
@@ -115,7 +115,7 @@ jobs:
           sudo apt-get update
           sudo apt-get install gettext-base
 
-      - name: Update docs/site/content/User/StepByStepGuide.md
+      - name: Update docs/site/content/en/docs/step-by-step-guide.md
         env:
           SOLO_TEST_CLUSTER: "solo-update-readme-${{ github.run_id }}-${{ github.run_attempt }}"
         run: |
@@ -135,17 +135,17 @@ jobs:
           
           ../.github/workflows/script/update_md.sh </dev/null | cat
           set +x
-          echo "::group::Updated StepByStepGuide.md"
+          echo "::group::Updated step-by-step-guide.md"
           
           cd ..
-          cat docs/site/content/User/StepByStepGuide.md
+          cat docs/site/content/en/docs/step-by-step-guide.md
           echo "::endgroup::"
 
-      - name: Check docs/site/content/User/StepByStepGuide.md Changes
+      - name: Check docs/site/content/en/docs/step-by-step-guide.md Changes
         id: check-readme-changes
         run: |
           set +e
-          echo "::group::Git Diff StepByStepGuide.md"
+          echo "::group::Git Diff step-by-step-guide.md"
           git diff --stat
           echo "::endgroup::"
                
@@ -167,7 +167,7 @@ jobs:
           fi
           
           TOTAL_LINES_CHANGED=$(($INSERTIONS + $DELETIONS))
-          echo "Total README lines changed: $TOTAL_LINES_CHANGED"
+          echo "Total step-by-step-guide.md lines changed: $TOTAL_LINES_CHANGED"
 
       - name: Import GPG key
         uses: step-security/ghaction-import-gpg@6c8fe4d0126a59d57c21f87c9ae5dd3451fa3cca # v6.1.0
@@ -178,15 +178,15 @@ jobs:
           git_user_signingkey: true
           git_commit_gpgsign: true
 
-      - name: Commit docs/site/content/User/StepByStepGuide.md Changes
+      - name: Commit docs/site/content/en/docs/step-by-step-guide.md Changes
         id: commit-readme
         if : ${{ github.event.inputs.dry-run-enabled != 'true' && !cancelled() && !failure() && inputs.commit-changes }}
         uses: stefanzweifel/git-auto-commit-action@b863ae1933cb653a53c021fe36dbb774e1fb9403 # v5.2.0
         with:
-          commit_message: "chore: auto update docs/site/content/User/StepByStepGuide.md"
+          commit_message: "chore: auto update docs/site/content/en/docs/step-by-step-guide.md"
           commit_options: '--no-verify --signoff'
           add_options: '-u'
-          file_pattern: 'docs/site/content/User/StepByStepGuide.md'
+          file_pattern: 'docs/site/content/en/docs/step-by-step-guide.md'
           commit_user_name: Swirlds Automation
           commit_user_email: [email protected]
           commit_author: Swirlds Automation <[email protected]>

.gitignore

@@ -473,13 +473,11 @@ coverage/
 deleteme.yaml
 /.nyc_output/
 /.nvmrc
-/docs/site/public/static/Classes/
-/docs/site/content/Classes/
-/docs/site/content/Developer/DEV.md
-/docs/site/content/User/README.md
-/docs/site/content/User/README
+/docs/site/content/en/images
 /docs/site/themes/
 /docs/site/.hugo_build.lock
 /docs/site/public/
 /contextDir/
 /docs/site/resources/
+/docs/site/.task/
+/docs/site/static/

DEV.md

@@ -1,3 +1,10 @@
+---
+title: "Contributing to Solo"
+weight: 20
+description: "Instructions for developers working on the Solo project"
+type: docs
+---
+
 # Instructions for developers working on solo project
 
 Below we describe how you can set up a local environment and contribute to `solo`.
@@ -20,14 +27,7 @@ Below we describe how you can set up a local environment and contribute to `solo
 
 ## E2E tests
 
-* In order to run E2E test, we need to set up cluster and install the chart.
-  * Run `./test/e2e/setup-e2e.sh`
+* In order to run E2E test, we need to set up a cluster and install the chart.
+  * Run `task test-setup`
   * Run `task test-e2e-standard`, NOTE: this excludes some E2E tests that have their own command
-  * You can check the section `scripts` in file `package.json` for more other test commands available.
-
-* Tests are run in random order. The random seed value is shown as message such as:
-  `Using timestamp seed 1711414247085 for random test order`
-
-* If you like to rerun tests with the same seed, use environment variable `RANDOM_SEED=<integer_number>` with `task test-e2e-standard` command.
-  * Example: `RANDOM_SEED=20 task test-e2e-standard`,
-    and you should see an output like: `Using preset seed 20 for random test order`
+  * You can check the command `task --list-all` for more other test commands available.

README.md

@@ -1,3 +1,15 @@
+---
+title: "Getting Started"
+weight: 1 
+description: >
+  Getting started with Solo 
+type: docs
+---
+
+> \[!WARNING]
+>
+> Any version of Solo prior to `v0.35.3` will fail on Apple M3/M4 chipsets due to a known issue with Java 21 and these chipsets.
+
 # Solo
 
 [![NPM Version](https://img.shields.io/npm/v/%40hashgraph%2Fsolo?logo=npm)](https://www.npmjs.com/package/@hashgraph/solo)
@@ -25,7 +37,7 @@ An opinionated CLI tool to deploy and manage standalone test networks.
 
 To run a three-node network, you will need to set up Docker Desktop with at least 8GB of memory and 4 CPUs.
 
-![alt text](images/DockerDesktop.png)
+![alt text](images/docker-desktop.png)
 
 ## Setup
 
@@ -57,7 +69,7 @@ nvm use v20.18.0
 
 ## Documentation
 
-[Getting Started](https://solo.hiero.org/User/StepByStepGuide/)
+[Getting Started](https://solo.hiero.org/docs/step-by-step-guide/)
 
 ## Contributing
 

Taskfile.yml

@@ -23,7 +23,7 @@ env:
   # DEBUG_NODE_ALIAS: "node2"
   # SOLO_CHARTS_DIR_FLAG: "--chart-dir /Users/user/source/solo-charts/charts"
   # LOAD_BALANCER_FLAG: "--load-balancer"
-  ENABLE_EXPLORER_TLS_FLAG: "--enable-hedera-explorer-tls"
+  ENABLE_EXPLORER_TLS_FLAG: "--enable-explorer-tls"
   TLS_CLUSTER_ISSUER_TYPE_FLAG: "--tls-cluster-issuer-type acme-staging"
   # NETWORK_DEPLOY_EXTRA_FLAGS: "--haproxy-ips node1="
   ENABLE_EXPLORER_INGRESS: "--enable-ingress"

docs/site/.cspell.yml

@@ -0,0 +1,7 @@
+# cSpell:ignore textlintrc
+# For settings, see
+# https://www.streetsidesoftware.com/vscode-spell-checker/docs/configuration/
+version: '0.2'
+caseSensitive: true
+words:
+  - Solo