Skip to content

Commit 8dc284b

Browse files
committed
update-command
Signed-off-by: ZihanKuang <zihan_kuang@outlook.com>
1 parent 3a128e7 commit 8dc284b

File tree

1 file changed

+16
-11
lines changed
  • content/en/cloud/academy/advanced-contribution-guide

1 file changed

+16
-11
lines changed

content/en/cloud/academy/advanced-contribution-guide/index.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -87,23 +87,28 @@ Use this workflow for end-to-end testing that mirrors the production environment
8787

8888
All steps in this section should be performed from the root of your local `academy-build` repository.
8989

90-
1. **Prepare Local Dependencies**: If you're testing local changes from other repositories (like a theme or content module), edit the `go.mod` file in `academy-build` to point to your local versions using a replace directive:
90+
1. **Install Dependencies**: Run this command once to install necessary dependencies.
91+
```bash
92+
make setup
93+
```
94+
95+
2. **Prepare Local Dependencies**: If you're testing local changes from other repositories (like a theme or content module), edit the `go.mod` file in `academy-build` to point to your local versions using a replace directive:
9196
```go
9297
replace github.com/layer5io/academy-theme => ../academy-theme
9398
replace github.com/layer5io/layer5-academy => ../layer5-academy
9499
```
95100
96-
2. **Build Locally**: Run the command to build the entire Academy site. This fetches all remote content modules and the theme:
97-
```bash
98-
make academy-dev
99-
```
101+
3. **Build for Staging**: Run the command to build the entire Academy site specifically for the staging environment.
102+
```bash
103+
make stg-build
104+
```
100105
101-
3. **Sync with Cloud**: After the build completes, run the following command to sync the generated static files with the Layer5 Cloud staging environment:
102-
```bash
103-
make sync-with-cloud
104-
```
106+
4. **Sync with Cloud**: After the build completes, run the following command to sync the generated static files with the Layer5 Cloud staging environment:
107+
```bash
108+
make sync-with-cloud
109+
```
105110
106-
4. **Preview on Staging**: Your changes will be available on the [staging environment](https://staging-cloud.layer5.io/) within approximately 10 minutes.
111+
5. **Preview on Staging**: Your changes will be available on the [staging environment](https://staging-cloud.layer5.io/) within approximately 10 minutes.
107112
108113
{{< alert type="warning" title="Local vs. Cloud Discrepancies" >}}
109114
The local preview (`make site`) is excellent for rapid development, but it is **not** a 100% accurate representation of the final product. The Cloud UI acts as a wrapper around the Academy content, which can introduce subtle differences. These are often caused by CSS class conflicts or variations in JavaScript execution within the larger application.
@@ -116,7 +121,7 @@ The local preview (`make site`) is excellent for rapid development, but it is **
116121
If you need a faster way to check the final output without syncing to the cloud, you can run a production-like build locally from the `academy-build` repo:
117122
118123
```bash
119-
make academy-prod
124+
make prod-build
120125
```
121126
122127
This command generates the final static files in the `public/` directory. You can inspect the generated HTML and JSON files here to diagnose build-time issues before deploying.

0 commit comments

Comments
 (0)