Skip to content

Commit 7cee66a

Browse files
authored
Add netlify deployment guide (#559)
* Add netlify deployment guide * Add pictures and adjust terminology * Add integration images
1 parent 66804db commit 7cee66a

File tree

12 files changed

+180
-1
lines changed

12 files changed

+180
-1
lines changed

app/components/IntegrationsList.vue

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ const integrations = [
2424
to: '/guides/integrations/vercel',
2525
logo: '/docs/img/vercel.webp',
2626
},
27+
{
28+
title: 'Netlify',
29+
description: 'Integrate Directus with Netlify to deploy sites and track build progress.',
30+
to: '/guides/integrations/netlify',
31+
logo: '/docs/img/tutorials/netlify.png',
32+
},
2733
];
2834
</script>
2935

content/guides/11.integrations/4.vercel/0.index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: vercel-integration
3-
title: Integration
3+
title: Vercel
44
description: Connect Directus with Vercel to trigger deployments, monitor build status, and manage your frontend projects directly from your Directus instance.
55
technologies:
66
- vercel
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
title: Netlify
2+
headline: Netlify
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
id: netlify-integration
3+
title: Netlify
4+
description: Integrate Directus with Netlify to deploy your sites, track build progress, and manage frontend projects from within your Directus instance.
5+
technologies:
6+
- netlify
7+
---
8+
9+
Integrate your Directus instance with Netlify to centrally deploy sites, track build progress, and manage multiple frontend projects — all from within Directus.
10+
11+
12+
::callout{icon="heroicons-outline:rocket-launch"}
13+
**Quick Start**
14+
1. **Enable Deployment module**: Enable the Deployment module in your Directus project settings
15+
2. **Link your Netlify account**: Go to the Deployment module and enter your Netlify Personal Access Token
16+
3. **Add sites**: Connect one or more Netlify sites to your Directus instance
17+
4. **Deploy**: Trigger builds and track deployment progress from Directus
18+
::
19+
20+
## Getting Started
21+
22+
### Link Your Netlify Account
23+
24+
1. In Directus, go to **Settings**
25+
2. Under **Modules**, enable the **Deployment** module
26+
3. Open the Deployment module from the **primary navigation**
27+
4. Select **Configure Netlify** to set up the integration
28+
- **Personal Access Token**: Your Netlify [personal access token](https://docs.netlify.com/api/get-started/#authentication)
29+
- **Account Slug (optional)**: Your [Account Slug](https://docs.netlify.com/manage/accounts-and-billing/team-management/overview/#access-or-modify-the-team-account-slug) to filter sites to a specific account. Leave empty to show all accessible sites
30+
5. Click **Save** to connect and start adding sites
31+
32+
![Netlify configuration token](/img/netlify-configuration-1.png)
33+
34+
### Configure Sites
35+
36+
1. From the **Netlify Configuration** screen, choose **which Netlify sites** to manage from Directus
37+
2. Click **Save** to add the selected sites
38+
3. Return to integration settings anytime to add or remove sites
39+
40+
::callout{icon="material-symbols:warning" color="warning"}
41+
**Removing Sites**
42+
<br>
43+
Removing a site from the Netlify integration will permanently delete all deployment history for that site from Directus. This cannot be undone.
44+
::
45+
46+
![Netlify configuration sites](/img/netlify-configuration-2.png)
47+
48+
### View Your Sites
49+
50+
Once set up, your connected Netlify sites appear in the Deployment module. From here you can:
51+
- See all connected sites at a glance
52+
- Access deployment controls for each site
53+
- Track deployment status and history
54+
55+
::callout{icon="material-symbols:info-outline"}
56+
**Permissions**
57+
<br>
58+
**Admin Access Required (For Now)**
59+
<br>
60+
At this time, only admin users can trigger deployments and manage Netlify sites. Role-based permissions are planned for an upcoming release, enabling deployment access for specific users and roles.
61+
::
62+
63+
![Netlify sites overview](/img/netlify-configuration-3.png)
64+
65+
## Documentation
66+
67+
**[Working with Deployments →](/guides/integrations/netlify/deployments)**
68+
69+
Trigger deployments, track build progress, and manage your frontend sites directly from Directus.
Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
---
2+
id: netlify-deployments
3+
title: Deployments
4+
description: Full guide for triggering builds, tracking deployment progress, and viewing logs for your Netlify sites from Directus.
5+
technologies:
6+
- netlify
7+
---
8+
9+
After linking your Netlify account and configuring your sites, manage all deployment activities directly from Directus.
10+
11+
Trigger deployments after publishing content updates that impact your frontend.
12+
13+
**[← Back to Netlify Integration](/guides/integrations/netlify)**
14+
15+
## Triggering Deployments
16+
17+
Start a new deployment for any connected Netlify site:
18+
19+
1. Navigate to the **Deployment** module
20+
2. Click on the **Netlify** provider
21+
3. Select the site you want to deploy
22+
4. Click the **Deploy** button in the top right
23+
5. Netlify will begin building and deploying your site
24+
25+
Each deployment is logged in Directus with its deployment metadata.
26+
27+
![Netlify integration overview](/img/netlify-integration-1.png)
28+
29+
## Monitoring Deployment Status
30+
31+
::callout{icon="material-symbols:info-outline"}
32+
**Only deployments triggered from Directus appear here**. Deployments initiated directly in Netlify will not be displayed.
33+
::
34+
35+
Track your deployments in the deployment list view. The list displays:
36+
37+
- **Deploy ID**: Netlify identifier for each build
38+
- **Status**: Current deployment state
39+
- `BUILDING`: Build is in progress
40+
- `READY`: Site is successfully built, deployed, and live
41+
- `CANCELED`: Deployment was stopped before completion
42+
- `ERROR`: Build or deploy phase failed
43+
- **Context**: Deployment environment (production, branch deploy, etc.)
44+
- **Started**: When the build began
45+
- **Duration**: Build time
46+
- **Author**: Who initiated the deployment
47+
48+
## Viewing Build Logs
49+
50+
Access detailed build logs for any deployment:
51+
52+
1. Click any deployment from the site list
53+
2. View the full build output, including:
54+
- Build steps and timing
55+
- Plugin execution details
56+
- Asset optimization and caching
57+
- Error messages (if applicable)
58+
3. Use **search** to locate specific log entries
59+
4. Filter by **log level** (All, Stdout, Stderr) to narrow results
60+
61+
Build logs are essential for diagnosing deployment issues and understanding your build pipeline.
62+
63+
![Netlify integration build logs](/img/netlify-integration-2.png)
64+
65+
## Exporting Logs
66+
67+
Download deployment logs for records or debugging:
68+
69+
1. Open the deployment details view
70+
2. Click the **Download** icon in the top right
71+
3. Logs are saved as a text file with timestamps
72+
73+
![Netlify integration export logs](/img/netlify-integration-3.png)
74+
75+
## Visiting Deployed Sites
76+
77+
Access your live deployments quickly:
78+
79+
1. From the deployment details view, click the **Visit** button
80+
2. Your deployed site opens in a new tab
81+
82+
![Netlify integration visit site](/img/netlify-integration-4.png)
83+
84+
## Best Practices
85+
86+
**Deployment Workflow**
87+
- Deploy after publishing content changes that affect your frontend
88+
- Monitor initial deployments after setup to confirm builds succeed
89+
- Retain build logs for failed deployments to aid troubleshooting
90+
91+
**Performance Tips**
92+
- Build durations in the deployment list help track performance trends
93+
- Netlify's build cache can accelerate subsequent builds
94+
95+
**Troubleshooting**
96+
- For failed deployments, review build logs for error details
97+
- Confirm your Netlify site configuration and build settings
98+
- Verify your Personal Access Token has required permissions
99+
100+
## Next Steps
101+
102+
- **[← Back to Integration](/guides/integrations/netlify)** Return to the integration overview
153 KB
Loading
161 KB
Loading
148 KB
Loading
157 KB
Loading
320 KB
Loading

0 commit comments

Comments
 (0)