Skip to content

Commit 64abb59

Browse files
committed
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
2 parents 0710ca7 + 358208d commit 64abb59

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+4514
-1327
lines changed

CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @docusign/1fe

README.md

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -52,32 +52,6 @@ yarn dev
5252
yarn build
5353
```
5454

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-
```
8155

8256
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.
8357

public/robots.txt

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,8 @@
1+
# 1fe Documentation Site Robots.txt
2+
# https://1fe.com
3+
14
User-agent: *
2-
Disallow: /
5+
Allow: /
6+
7+
# Crawl delay for respectful crawling (for bots that support it)
8+
Crawl-delay: 1

src/assets/playground.png

50 KB
Loading

src/components/feature-alt.astro

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ const { nomargin } = Astro.props;
1313
"max-w-4xl mx-auto flex flex-col items-center justify-center",
1414
!nomargin && "mt-24",
1515
]}>
16-
<Badge color="purple">The 1fe Runtime is alive!</Badge>
16+
<Badge color="purple">🚀 Next-Gen Micro-Frontend</Badge>
1717
<h2 class="text-4xl lg:text-5xl font-bold lg:tracking-tight mt-4 text-center">
18-
A Dynamic Runtime
18+
Micro-Frontend That <br/><span class="text-purple-600">Actually Works</span>
1919
</h2>
2020
<p class="text-lg mt-4 text-slate-600 text-center [text-wrap:pretty]">
21-
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.
2222
</p>
2323
</div>
2424

@@ -34,31 +34,28 @@ const { nomargin } = Astro.props;
3434

3535
<div class="grid place-items-center">
3636
<div class="max-w-lg">
37-
<Badge color="purple" class="-ml-px">A Unified App Shell</Badge>
37+
<Badge color="purple" class="-ml-px">⚡ Live Configuration Magic</Badge>
3838
<h3 class="text-2xl font-medium mt-4 [text-wrap:balance]">
39-
Standardize Web Utilities Across Products
39+
Deploy Once, Update Forever
4040
</h3>
4141
<p class="mt-4 text-slate-600 [text-wrap:balance]">
42-
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.
4343
</p>
4444

4545
<ul class="grid mt-6 text-left gap-y-4">
4646
<li class="flex items-center gap-3 text-neutral-800">
47-
<Icon name="ph:check-circle-fill" class="w-5 h-5" aria-hidden="true" />
48-
49-
<span class="text-sm">Browser Storage</span>
47+
<Icon name="ph:check-circle-fill" class="w-5 h-5 text-green-600" aria-hidden="true" />
48+
<span class="text-sm"><strong>Zero-Downtime Deployments</strong> - Update widgets while users browse</span>
5049
</li>
5150

5251
<li class="flex items-center gap-3 text-neutral-800">
53-
<Icon name="ph:check-circle-fill" class="w-5 h-5" aria-hidden="true" />
54-
55-
<span class="text-sm">Event Bus</span>
52+
<Icon name="ph:check-circle-fill" class="w-5 h-5 text-green-600" aria-hidden="true" />
53+
<span class="text-sm"><strong>Live Config Updates</strong> - No rebuilds, no restarts required</span>
5654
</li>
5755

5856
<li class="flex items-center gap-3 text-neutral-800">
59-
<Icon name="ph:check-circle-fill" class="w-5 h-5" aria-hidden="true" />
60-
61-
<span class="text-sm">Performance Metrics</span>
57+
<Icon name="ph:check-circle-fill" class="w-5 h-5 text-green-600" aria-hidden="true" />
58+
<span class="text-sm"><strong>Independent Teams</strong> - Deploy at your own pace, no coordination</span>
6259
</li>
6360
</ul>
6461
</div>

src/content/docs/explanation/why.mdx

Lines changed: 0 additions & 70 deletions
This file was deleted.

src/content/docs/infrastructure/cdn-setup.mdx renamed to src/content/docs/how-to-guides/Infrastructure Setup/cdn-setup.mdx

Lines changed: 85 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
11
---
2-
title: 'CDN Setup for Widget Bundles'
3-
description: 'Configure CDN hosting for your 1fe widget bundles and static assets'
2+
title: "CDN Setup for Widget Bundles"
3+
description: "Configure CDN hosting for your 1fe widget bundles and static assets"
44
---
55

6-
import {
7-
FcFlashOn,
8-
FcSettings,
9-
FcDeployment,
10-
FcGlobe,
11-
} from "react-icons/fc";
6+
import { FcFlashOn, FcSettings, FcDeployment, FcGlobe } from "react-icons/fc";
127
import {
138
FaCloud,
149
FaDatabase,
@@ -19,12 +14,7 @@ import {
1914
FaAws,
2015
FaGoogle,
2116
} from "react-icons/fa";
22-
import {
23-
SiAkamai,
24-
SiCloudflare,
25-
SiFastly,
26-
SiJsdelivr,
27-
} from "react-icons/si";
17+
import { SiAkamai, SiCloudflare, SiFastly, SiJsdelivr } from "react-icons/si";
2818

2919
<div className="infrastructure-header">
3020

@@ -52,9 +42,10 @@ We use Akamai NetStorage to host our widget bundles and static assets, but your
5242
**Official Documentation:** [Akamai NetStorage User Guide](https://techdocs.akamai.com/netstorage/docs)
5343

5444
:::note[Key Concepts]
45+
5546
- **Storage Group**: A logical container for your content that defines its storage location and replication settings.
5647
- **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+
:::
5849

5950
:::note
6051
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
196187
Ensure the key file has proper permissions (`chmod 600`).
197188

198189
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).
200191

201192
</section>
202193

@@ -205,7 +196,7 @@ The rsync command uses specific flags for secure, efficient file transfers to Ne
205196

206197
- **[1fe-ci-cd Repository](https://github.com/docusign/1fe-ci-cd)** - Complete CI/CD workflows and deployment scripts
207198
- **[mock-cdn-assets Repository](https://github.com/docusign/mock-cdn-assets)** - Example asset structures and upload configurations
208-
:::
199+
:::
209200

210201
:::tip[Complete Examples Available]
211202
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
215206

216207
#### <SiAkamai style={{ display: 'inline', marginRight: '0.5rem', verticalAlign: 'middle', color: '#0096D6' }} /> Step 4: Configure an Akamai CDN Property
217208

218-
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.
219210

220211
**Setup Instructions:**
221212

@@ -272,7 +263,8 @@ The final step is to create a CDN property to serve content from your NetStorage
272263

273264
</section>
274265

275-
**Official Documentation:**
266+
**Official Documentation:**
267+
276268
- [Property Manager User Guide](https://techdocs.akamai.com/property-mgr/docs)
277269
- [Creating a New Property](https://techdocs.akamai.com/property-mgr/docs/create-a-new-property)
278270

@@ -301,15 +293,17 @@ We have setup two environments for our CDN:
301293

302294
:::note[Environment Separation]
303295
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+
:::
305297

306298
## Additional Resources
307299

308300
### 1fe Implementation Resources
301+
309302
- **[1fe-ci-cd Repository](https://github.com/docusign/1fe-ci-cd)** - Complete CI/CD workflows and deployment automation
310303
- **[mock-cdn-assets Repository](https://github.com/docusign/mock-cdn-assets)** - Example asset structures and configurations
311304

312305
### Akamai Resources
306+
313307
- **[Akamai Control Center](https://control.akamai.com/)** - Main management interface
314308
- **[Akamai Developer Portal](https://developer.akamai.com/)** - APIs and automation tools
315309
- **[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
320314
While this guide focuses on Akamai CDN setup, you can use other CDN providers for hosting your 1fe widget bundles:
321315

322316
**Cloud Provider CDNs:**
323-
- <FaAws style={{ display: 'inline-block', marginRight: '0.5rem', verticalAlign: 'middle', color: '#FF9900' }} /> Amazon CloudFront (AWS)
324-
- <FaMicrosoft style={{ display: 'inline-block', marginRight: '0.5rem', verticalAlign: 'middle', color: '#0078D4' }} /> Azure CDN
325-
- <FaGoogle style={{ display: 'inline-block', marginRight: '0.5rem', verticalAlign: 'middle', color: '#4285F4' }} /> Google Cloud CDN
317+
318+
- <FaAws
319+
style={{
320+
display: "inline-block",
321+
marginRight: "0.5rem",
322+
verticalAlign: "middle",
323+
color: "#FF9900",
324+
}}
325+
/> Amazon CloudFront (AWS)
326+
- <FaMicrosoft
327+
style={{
328+
display: "inline-block",
329+
marginRight: "0.5rem",
330+
verticalAlign: "middle",
331+
color: "#0078D4",
332+
}}
333+
/> Azure CDN
334+
- <FaGoogle
335+
style={{
336+
display: "inline-block",
337+
marginRight: "0.5rem",
338+
verticalAlign: "middle",
339+
color: "#4285F4",
340+
}}
341+
/> Google Cloud CDN
326342

327343
**Modern CDN Services:**
328-
- <SiCloudflare style={{ display: 'inline-block', marginRight: '0.5rem', verticalAlign: 'middle', color: '#F38020' }} /> Cloudflare
329-
- <SiFastly style={{ display: 'inline-block', marginRight: '0.5rem', verticalAlign: 'middle', color: '#FF282D' }} /> Fastly
330-
- <FaCloud style={{ display: 'inline-block', marginRight: '0.5rem', verticalAlign: 'middle', color: '#00AAFF' }} /> KeyCDN
344+
345+
- <SiCloudflare
346+
style={{
347+
display: "inline-block",
348+
marginRight: "0.5rem",
349+
verticalAlign: "middle",
350+
color: "#F38020",
351+
}}
352+
/> Cloudflare
353+
- <SiFastly
354+
style={{
355+
display: "inline-block",
356+
marginRight: "0.5rem",
357+
verticalAlign: "middle",
358+
color: "#FF282D",
359+
}}
360+
/> Fastly
361+
- <FaCloud
362+
style={{
363+
display: "inline-block",
364+
marginRight: "0.5rem",
365+
verticalAlign: "middle",
366+
color: "#00AAFF",
367+
}}
368+
/> KeyCDN
331369

332370
**Specialized Solutions:**
333-
- <SiJsdelivr style={{ display: 'inline-block', marginRight: '0.5rem', verticalAlign: 'middle', color: '#E84D3D' }} /> JSDelivr
334-
- <FaNpm style={{ display: 'inline-block', marginRight: '0.5rem', verticalAlign: 'middle', color: '#CB3837' }} /> UnPkg
371+
372+
- <SiJsdelivr
373+
style={{
374+
display: "inline-block",
375+
marginRight: "0.5rem",
376+
verticalAlign: "middle",
377+
color: "#E84D3D",
378+
}}
379+
/> JSDelivr
380+
- <FaNpm
381+
style={{
382+
display: "inline-block",
383+
marginRight: "0.5rem",
384+
verticalAlign: "middle",
385+
color: "#CB3837",
386+
}}
387+
/> UnPkg
335388

336389
## Next Steps
337390

338391
After setting up your CDN:
339-
1. [Configure Configuration Service](/infrastructure/configuration-setup/)
340-
2. [Set up NPM Registry](/infrastructure/npm-registry-setup/)
341-
3. [Implement CI/CD Integration](/infrastructure/project-setup/)
392+
393+
1. [Configure Configuration Service](/how-to-guides/infrastructure%20setup/configuration-setup/)
394+
2. [Set up NPM Registry](/how-to-guides/infrastructure%20setup/npm-registry-setup/)
395+
3. [Implement CI/CD Integration](/how-to-guides/infrastructure%20setup/project-setup/)

0 commit comments

Comments
 (0)