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
Resolve merge conflicts: update documentation links and structure
- Remove obsolete Project Structure section from README.md
- Update link paths in infrastructure setup guides to match new directory structure
- Keep updated paths for configuration-setup.mdx, npm-registry-setup.mdx, and project-setup.mdx
Copy file name to clipboardExpand all lines: README.md
-26Lines changed: 0 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,32 +52,6 @@ yarn dev
52
52
yarn build
53
53
```
54
54
55
-
## Project Structure
56
-
57
-
Inside of this Astro documentation project, you'll see the following folders and files:
58
-
59
-
```text
60
-
/
61
-
├── public/
62
-
│ ├── favicon.svg
63
-
│ └── robots.txt
64
-
├── src/
65
-
│ ├── content/
66
-
│ │ ├── docs/ # Documentation content
67
-
│ │ │ ├── start-here/
68
-
│ │ │ ├── tutorials/
69
-
│ │ │ ├── learning/
70
-
│ │ │ ├── how-to-guides/
71
-
│ │ │ ├── infrastructure/
72
-
│ │ │ ├── reference/
73
-
│ │ │ └── ...
74
-
│ │ └── config.ts # Content collections config
75
-
│ ├── components/ # Reusable Astro components
76
-
│ ├── layouts/ # Page layouts
77
-
│ └── assets/ # Images and other assets
78
-
├── astro.config.mjs # Astro configuration
79
-
└── package.json
80
-
```
81
55
82
56
Documentation content is written in MDX format and stored in the `src/content/docs/` directory. Each file automatically becomes a page based on its file path.
1fe's configuration-driven runtime pulls and orchestrates widgets independently to stitch together dynamic pages. A living and breathing Ecosystem, when deployed, does not need to be restarted when widgets release.
21
+
1fe revolutionizes micro-frontend architecture with <strong>live configuration management</strong>. Deploy widgets independently, update instantly, and scale without limits—all while your app keeps running. No restarts. No rebuilds. Just pure dynamic power.
The Runtime provides contextual data and configurable web helper utilities to widgets to help them render and interact with the page.
42
+
Unlike traditional module federation, 1fe's dynamic runtime orchestrates micro-frontends through live configs. Change widget versions, update features, or rollback instantly—all without touching your main app.
@@ -52,9 +42,10 @@ We use Akamai NetStorage to host our widget bundles and static assets, but your
52
42
**Official Documentation:**[Akamai NetStorage User Guide](https://techdocs.akamai.com/netstorage/docs)
53
43
54
44
:::note[Key Concepts]
45
+
55
46
-**Storage Group**: A logical container for your content that defines its storage location and replication settings.
56
47
-**Upload Directory**: A specific directory within a Storage Group where you upload your files. Each directory is assigned a unique CP Code (Content Provider Code) which is used to link it to your CDN configuration.
57
-
:::
48
+
:::
58
49
59
50
:::note
60
51
NetStorage serves as the origin for your CDN. All widget bundles, assets, and manifests will be stored here and served globally through Akamai's edge network.
@@ -196,7 +187,7 @@ With the storage configured, you can now upload your content using rsync over SS
196
187
Ensure the key file has proper permissions (`chmod 600`).
197
188
198
189
6.**Store Key Securely**
199
-
Store the key securely for CI/CD use. For guidance on adding secrets to your CI/CD pipeline, see the [Secrets Management section](/infrastructure/project-setup/#11-secrets-management).
190
+
Store the key securely for CI/CD use. For guidance on adding secrets to your CI/CD pipeline, see the [Secrets Management section](/how-to-guides/infrastructure%20setup/project-setup/#11-secrets-management).
200
191
201
192
</section>
202
193
@@ -205,7 +196,7 @@ The rsync command uses specific flags for secure, efficient file transfers to Ne
205
196
206
197
-**[1fe-ci-cd Repository](https://github.com/docusign/1fe-ci-cd)** - Complete CI/CD workflows and deployment scripts
207
198
-**[mock-cdn-assets Repository](https://github.com/docusign/mock-cdn-assets)** - Example asset structures and upload configurations
208
-
:::
199
+
:::
209
200
210
201
:::tip[Complete Examples Available]
211
202
For complete rsync command examples and production-ready scripts, see the **[1fe-ci-cd repository](https://github.com/docusign/1fe-ci-cd)** which contains tested deployment workflows.
@@ -215,7 +206,7 @@ For complete rsync command examples and production-ready scripts, see the **[1fe
The final step is to create a CDN property to serve content from your NetStorage origin.
209
+
The final step is to create a CDN property to serve content from your NetStorage origin.
219
210
220
211
**Setup Instructions:**
221
212
@@ -272,7 +263,8 @@ The final step is to create a CDN property to serve content from your NetStorage
272
263
273
264
</section>
274
265
275
-
**Official Documentation:**
266
+
**Official Documentation:**
267
+
276
268
-[Property Manager User Guide](https://techdocs.akamai.com/property-mgr/docs)
277
269
-[Creating a New Property](https://techdocs.akamai.com/property-mgr/docs/create-a-new-property)
278
270
@@ -301,15 +293,17 @@ We have setup two environments for our CDN:
301
293
302
294
:::note[Environment Separation]
303
295
However, you may setup as many environments as you need. Different environments are used to separate different versions of your widget bundles and static assets, ensuring safe testing and reliable production delivery.
304
-
:::
296
+
:::
305
297
306
298
## Additional Resources
307
299
308
300
### 1fe Implementation Resources
301
+
309
302
-**[1fe-ci-cd Repository](https://github.com/docusign/1fe-ci-cd)** - Complete CI/CD workflows and deployment automation
310
303
-**[mock-cdn-assets Repository](https://github.com/docusign/mock-cdn-assets)** - Example asset structures and configurations
311
304
312
305
### Akamai Resources
306
+
313
307
-**[Akamai Control Center](https://control.akamai.com/)** - Main management interface
314
308
-**[Akamai Developer Portal](https://developer.akamai.com/)** - APIs and automation tools
315
309
-**[Akamai CLI](https://github.com/akamai/cli)** - Command-line interface for automation
@@ -320,22 +314,82 @@ However, you may setup as many environments as you need. Different environments
320
314
While this guide focuses on Akamai CDN setup, you can use other CDN providers for hosting your 1fe widget bundles:
0 commit comments