Skip to content

Commit 9002452

Browse files
jeromy-cannonjeromy-cannon
authored
fix: updated GitHub Pages docs, fixed solo deployment create to prompt for additional flags (#1801)
Signed-off-by: Jeromy Cannon <[email protected]>
1 parent 1fc04b2 commit 9002452

18 files changed

+425
-187
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ on:
2323
# Runs on pushes targeting the default branch
2424
push:
2525
branches:
26-
- main
26+
- release/0.35
2727
paths:
2828
- '**/*.mjs'
2929
- '**/*.js'
@@ -102,20 +102,20 @@ jobs:
102102
# Upload the built site to GitHub Pages
103103
- name: Upload Pages Artifact
104104
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
105-
if: ${{ endsWith(github.ref, 'main') }}
105+
if: ${{ endsWith(github.ref, 'release/0.35') }}
106106
with:
107107
path: ./docs/public
108108

109109
# Upload the built site to artifacts for troubleshooting or verification
110110
- name: Upload Artifact
111111
uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
112-
if: ${{ !endsWith(github.ref, 'main') }}
112+
if: ${{ !endsWith(github.ref, 'release/0.35') }}
113113
with:
114114
path: ./docs/public
115115

116116
# Deployment job
117117
Deploy:
118-
if: ${{ endsWith(github.ref, 'main') }}
118+
if: ${{ endsWith(github.ref, 'release/0.35') }}
119119
environment:
120120
name: github-pages
121121
url: ${{ steps.deployment.outputs.page_url }}

‎.github/workflows/script/update_md.sh

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,11 @@
55

66
set -xeo pipefail
77

8-
if [[ -z "${SOLO_TEST_CLUSTER}" && ${SOLO_CLUSTER_NAME} != "" ]]; then
8+
if [[ -z "${SOLO_TEST_CLUSTER}" ]]; then
99
SOLO_CLUSTER_NAME=solo-e2e
1010
else
1111
SOLO_CLUSTER_NAME=${SOLO_TEST_CLUSTER}
1212
fi
13-
1413
export SOLO_NAMESPACE=solo
1514
export SOLO_DEPLOYMENT=solo-deployment
1615
export SOLO_CLUSTER_SETUP_NAMESPACE=solo-cluster
@@ -45,14 +44,17 @@ export SOLO_NODE_START_OUTPUT=$( cat node-start.log | tee test.log )
4544
solo mirror-node deploy --deployment "${SOLO_DEPLOYMENT}" | tee mirror-node-deploy.log
4645
export SOLO_MIRROR_NODE_DEPLOY_OUTPUT=$( cat mirror-node-deploy.log | tee test.log )
4746

47+
solo explorer deploy --deployment "${SOLO_DEPLOYMENT}" --cluster-ref kind-${SOLO_CLUSTER_NAME} | tee explorer-deploy.log
48+
export SOLO_EXPLORER_DEPLOY_OUTPUT=$( cat explorer-deploy.log | tee test.log )
49+
4850
solo relay deploy -i node1,node2,node3 --deployment "${SOLO_DEPLOYMENT}" | tee relay-deploy.log
4951
export SOLO_RELAY_DEPLOY_OUTPUT=$( cat relay-deploy.log | tee test.log )
5052

5153
echo "Generate README.md"
5254

5355
envsubst '$KIND_CREATE_CLUSTER_OUTPUT,$SOLO_INIT_OUTPUT,$SOLO_NODE_KEY_PEM_OUTPUT,$SOLO_CLUSTER_SETUP_OUTPUT, \
5456
$SOLO_DEPLOYMENT_CREATE_OUTPUT,$SOLO_NETWORK_DEPLOY_OUTPUT,$SOLO_NODE_SETUP_OUTPUT,$SOLO_NODE_START_OUTPUT,\
55-
$SOLO_MIRROR_NODE_DEPLOY_OUTPUT,$SOLO_RELAY_DEPLOY_OUTPUT'\
57+
$SOLO_MIRROR_NODE_DEPLOY_OUTPUT,$SOLO_EXPLORER_DEPLOY_OUTPUT,$SOLO_RELAY_DEPLOY_OUTPUT'\
5658
< docs/content/User/StepByStepGuide.md.template > docs/content/User/StepByStepGuide.md
5759

5860
echo "Remove color codes and lines showing intermediate progress"

‎.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -482,3 +482,5 @@ deleteme.yaml
482482
/docs/.hugo_build.lock
483483
/docs/public/
484484
/contextDir/
485+
/docs/content/User/README/images/DockerDesktop.png
486+
/docs/content/User/README/index.md

‎README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@
77
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/83a423a3a1c942459127b3aec62ab0b5)](https://app.codacy.com/gh/hashgraph/solo/dashboard?utm_source=gh\&utm_medium=referral\&utm_content=\&utm_campaign=Badge_grade)
88
[![codecov](https://codecov.io/gh/hashgraph/solo/graph/badge.svg?token=hBkQdB1XO5)](https://codecov.io/gh/hashgraph/solo)
99

10-
> \[!WARNING]
11-
> SPECIAL NOTICE: Introducing v0.32.0 comes with BREAKING CHANGES. We have removed caching of the flags in the solo config file. All commands will need required flags or user will need to answer the prompts. See more details in our release notes: [release/tag/v0.32.0](https://github.com/hashgraph/solo/releases/tag/v0.32.0)
12-
1310
An opinionated CLI tool to deploy and manage standalone test networks.
1411

1512
## Requirements
@@ -57,7 +54,7 @@ nvm use v20.18.0
5754

5855
## Documentation
5956

60-
[Getting Started](https://hashgraph.github.io/solo/)
57+
[Getting Started](https://hashgraph.github.io/solo/User/StepByStepGuide)
6158

6259
## Support
6360

‎docs/content/User/TaskTool.md renamed to ‎docs/content/Developer/Development/TaskTool.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Use the Task tool to launch Solo
22

3-
For users who want to quickly deploy a standalone solo network without need to know what is under the hood,
3+
For developers who want to quickly deploy a standalone solo network without need to know what is under the hood,
44
they can use the Task tool to launch the network with a single command.
55

66
First, install the cluster tool `kind` with this [link](https://kind.sigs.k8s.io/docs/user/quick-start#installation)
@@ -11,7 +11,7 @@ Then, install the task tool `task` with this [link](https://taskfile.dev/install
1111

1212
### Start solo network
1313

14-
User can use one of the following three commands to quickly deploy a standalone solo network.
14+
The developer can use one of the following three commands to quickly deploy a standalone solo network.
1515

1616
```bash
1717
# Option 1) deploy solo network with two nodes `task` is the same as `task default`

‎docs/content/User/AccessHederaServices.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
## Access Hedera Network Services
22

3+
> **⚠️ Warning**
4+
> This document is out of date for the current release. See [Step-by-step Guide](./StepByStepGuide.md) for the updated base commands to run that can be augmented with the extra flags and values provided in this guide. Hedera services and Platform SDK have moved to hiero-consensus-node repo <https://github.com/hiero-ledger/hiero-consensus-node>
5+
36
Once the nodes are up, you may now expose various services (using `k9s` (shift-f) or `kubectl port-forward`) and access. Below are most used services that you may expose.
47

58
* Node services: `network-<node ID>-svc`

‎docs/content/User/DebugLog/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
## How to debug Hedera Services and Platform SDK
22

3+
> **⚠️ Warning**
4+
> This document is out of date for the current release. See [Step-by-step Guide](../StepByStepGuide.md) for the updated base commands to run that can be augmented with the extra flags and values provided in this guide. Hedera services and Platform SDK have moved to hiero-consensus-node repo <https://github.com/hiero-ledger/hiero-consensus-node>
5+
36
### 1. Using k9s to access running network nodes logs
47

58
Running the command `k9s -A` in terminal, and select one of the network nodes:

‎docs/content/User/FAQ.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
> **⚠️ Warning**
2+
> This document is out of date for the current release. See [Step-by-step Guide](./StepByStepGuide.md) for the updated base commands to run that can be augmented with the extra flags and values provided in this guide. Hedera services and Platform SDK have moved to hiero-consensus-node repo <https://github.com/hiero-ledger/hiero-consensus-node>
3+
14
### How can I avoid using genesis keys ?
25

36
You can run `solo account init` anytime after `solo node start`

‎docs/content/User/GetStarted.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Quick start:
44

5-
* [Start solo network with single command](TaskTool.md)
5+
* [Start solo network with single command](../Developer/Development/TaskTool.md)
66

77
For Developers working on Hedera Application and platform development:
88

‎docs/content/User/HederaDeveloper.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
### Use solo with local build hedera service code
22

3+
> **⚠️ Warning**
4+
> This document is out of date for the current release. See [Step-by-step Guide](./StepByStepGuide.md) for the updated base commands to run that can be augmented with the extra flags and values provided in this guide. Hedera services and Platform SDK have moved to hiero-consensus-node repo <https://github.com/hiero-ledger/hiero-consensus-node>
5+
36
First, please clone hedera service repo `https://github.com/hashgraph/hedera-services/` and build the code
47
with `./gradlew assemble`. If need to running multiple nodes with different versions or releases, please duplicate the repo or build directories in
58
multiple directories, checkout to the respective version and build the code.

‎docs/content/User/PlatformDeveloper.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
### Use solo with local build platform code
22

3+
> **⚠️ Warning**
4+
> This document is out of date for the current release. See [Step-by-step Guide](./StepByStepGuide.md) for the updated base commands to run that can be augmented with the extra flags and values provided in this guide. Hedera services and Platform SDK have moved to hiero-consensus-node repo <https://github.com/hiero-ledger/hiero-consensus-node>
5+
36
First, please clone hedera service repo `https://github.com/hashgraph/hedera-services/` and build the code
47
with `./gradlew assemble`. If need to running nodes with different versions or releases, please duplicate the repo or build directories in
58
multiple directories, checkout to the respective version and build the code.

‎docs/content/User/SDK.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Using Solo with Hedera JavaScript SDK
22

3+
> **⚠️ Warning**
4+
> This document is out of date for the current release. See [Step-by-step Guide](./StepByStepGuide.md) for the updated base commands to run that can be augmented with the extra flags and values provided in this guide. Hedera services and Platform SDK have moved to hiero-consensus-node repo <https://github.com/hiero-ledger/hiero-consensus-node>
5+
36
First, please follow solo repository README to install solo and Docker Desktop.
47
You also need to install the Taskfile tool following the instructions [here](https://taskfile.dev/installation/).
58

‎docs/content/User/SoloCLI.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Solo command line user manual
22

3+
> **⚠️ Warning**
4+
> This document is out of date for the current release. See [Step-by-step Guide](./StepByStepGuide.md) for the updated base commands to run that can be augmented with the extra flags and values provided in this guide. Hedera services and Platform SDK have moved to hiero-consensus-node repo <https://github.com/hiero-ledger/hiero-consensus-node>
5+
36
Solo has a series of commands to use, and some commands have subcommands.
47
User can get help information by running with the following methods:
58

‎docs/content/User/SoloWithMirrorNode.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
## Using Solo with mirror node
22

3+
> **⚠️ Warning**
4+
> This document is out of date for the current release. See [Step-by-step Guide](./StepByStepGuide.md) for the updated base commands to run that can be augmented with the extra flags and values provided in this guide. Hedera services and Platform SDK have moved to hiero-consensus-node repo <https://github.com/hiero-ledger/hiero-consensus-node>
5+
36
User can deploy a solo network with mirror node by running the following command:
47

58
```bash
@@ -24,7 +27,7 @@ kubectl port-forward svc/hedera-explorer -n "${SOLO_NAMESPACE}" 8080:80 > /dev/n
2427

2528
Then you can access the hedera explorer at `http://localhost:8080`
2629

27-
Or you can use Task tool to deploy solo network with mirror node with a single command [link](TaskTool.md)
30+
Or you can use Task tool to deploy solo network with mirror node with a single command [link](../Developer/Development/TaskTool.md)
2831

2932
Next, you can try to create a few accounts with solo and see the transactions in the explorer.
3033

0 commit comments

Comments
 (0)