You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/cloud/academy/advanced-contribution-guide/index.md
+16-11Lines changed: 16 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,23 +87,28 @@ Use this workflow for end-to-end testing that mirrors the production environment
87
87
88
88
All steps in this section should be performed from the root of your local `academy-build` repository.
89
89
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:
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
+
```
100
105
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
+
```
105
110
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.
107
112
108
113
{{< alert type="warning" title="Local vs. Cloud Discrepancies" >}}
109
114
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 **
116
121
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:
117
122
118
123
```bash
119
-
make academy-prod
124
+
make prod-build
120
125
```
121
126
122
127
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