Skip to content

Commit 2bacbb4

Browse files
authored
Merge pull request #11 from docusign/cvarma/doc-1
CI-CD Docs for 1FE customers.
2 parents 56b609a + 1ab9da5 commit 2bacbb4

File tree

10 files changed

+2200
-16
lines changed

10 files changed

+2200
-16
lines changed

astro.config.mjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ export default defineConfig({
3030
src: './src/assets/1fe-logo.svg',
3131
},
3232
sidebar: sidebarConfig,
33+
disable404Route: true,
3334
expressiveCode: {
3435
// You can optionally override the plugin's default settings here
3536
frames: {},

config-utils/sidebar.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,12 @@ export const sidebarConfig = [
2323
collapsed: true,
2424
// attrs: { style: "text-transform: 'capitalized'" },
2525
},
26-
26+
{
27+
label: "Infrastructure Setup",
28+
autogenerate: { directory: "infrastructure" },
29+
collapsed: true,
30+
// attrs: { style: "text-transform: 'capitalized'" },
31+
},
2732
{
2833
label: "Reference",
2934
autogenerate: { directory: "reference" },

src/content/docs/how-to-guides/productionize.mdx

Lines changed: 43 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,59 @@ description: "Setup infra for production 1fe instance"
44
---
55

66
import { SlRocket } from "react-icons/sl";
7+
import {
8+
FaMicrosoft,
9+
FaCloud,
10+
FaNpm,
11+
FaGithub,
12+
FaDatabase,
13+
} from "react-icons/fa";
714

815
Let's get your 1fe instance ready for production! We shall cover the following topics in this guide:
916

10-
<div className="prose">
11-
1. **Setup a hosting service for your 1fe instance.** 2. **Setup a static
12-
hosting service for your bundles.** 3. **Setup a npm registry.** 4. **Setup a
13-
configuration service.** 5. **Setup a CI/CD system.**
14-
</div>
17+
## Quick Start Checklist
1518

16-
## 1. Setup a Hosting Service for Your 1fe Instance
19+
:::tip[Recommended Setup Order]
20+
Follow these steps in order for the smoothest setup experience:
1721

18-
Coming soon... This section will cover how to deploy your 1fe instance to production hosting services like Vercel, Netlify, AWS, or your preferred cloud provider.
22+
1. [Setup Hosting Service](/infrastructure/hosting-setup/) - Deploy your 1FE application
23+
2. [Setup CDN](/infrastructure/cdn-setup/) - Configure widget bundle hosting
24+
3. [Setup NPM Registry](/infrastructure/npm-registry-setup/) - Manage NPM packages
25+
4. [Setup Configuration Service](/infrastructure/configuration-setup/) - Manage live configurations
26+
5. [Setup CI/CD](/infrastructure/project-setup/) - Automate deployments
27+
:::
1928

20-
## 2. Setup a Static Hosting Service for Your Bundles
29+
Each step builds on the previous one, ensuring your production infrastructure is robust and scalable.
2130

22-
Coming soon... This section will cover how to set up CDN hosting for your widget bundles using services like AWS S3 + CloudFront, Azure Blob Storage, or other CDN providers.
31+
## <FaMicrosoft style={{ display: 'inline', marginRight: '0.5rem', verticalAlign: 'middle', color: '#0078D4' }} /> 1. Setup a Hosting Service for Your 1fe Instance
2332

24-
## 3. Setup a NPM Registry
33+
Your 1fe application shell needs to be hosted on a reliable service that can handle user traffic and serve your application globally.
2534

26-
Coming soon... This section will cover how to set up a private NPM registry for your widgets and manage package distribution in a production environment.
35+
**[→ Detailed Hosting Setup Guide](/infrastructure/hosting-setup/)**
2736

28-
## 4. Setup a Configuration Service
37+
## <FaCloud style={{ display: 'inline', marginRight: '0.5rem', verticalAlign: 'middle', color: '#1F8BF3' }} /> 2. Setup a Static Hosting Service for Your Bundles
2938

30-
Coming soon... This section will cover how to set up a robust configuration management system for your Live Configurations, including environment-specific settings and deployment strategies.
39+
You can use a CDN service to host your built widget bundles for both integration and production environments.
3140

32-
## 5. Setup a CI/CD System
41+
**[→ Detailed CDN Setup Guide](/infrastructure/cdn-setup/)**
3342

34-
Coming soon... This section will cover how to implement continuous integration and deployment pipelines for your 1fe widgets and instances, including automated testing, building, and deployment to your CDN and hosting services.
43+
44+
## <FaNpm style={{ display: 'inline', marginRight: '0.5rem', verticalAlign: 'middle', color: '#CB3837' }} /> 3. Setup a NPM Registry
45+
46+
A private NPM registry is essential for managing your 1fe widget packages securely and efficiently in a production environment.
47+
48+
**[→ Detailed NPM Registry Setup Guide](/infrastructure/npm-registry-setup/)**
49+
50+
## <FaDatabase style={{ display: 'inline', marginRight: '0.5rem', verticalAlign: 'middle', color: '#4CAF50' }} /> 4. Setup a Configuration Service
51+
52+
53+
1fe requires a configuration service to manage **widget metadata** including version information, deployment status, and dependencies.
54+
55+
56+
**[→ Detailed Configuration Service Setup Guide](/infrastructure/configuration-setup/)**
57+
58+
## <FaGithub style={{ display: 'inline', marginRight: '0.5rem', verticalAlign: 'middle', color: '#181717' }} /> 5. Setup a CI/CD System
59+
60+
1fe uses a centralized CI/CD system to manage deployments across all widgets.
61+
62+
**[→ CI/CD Project Setup Documentation](/infrastructure/project-setup/)**

0 commit comments

Comments
 (0)