Skip to content

Commit f4c1e49

Browse files
committed
add information about plugin to readme and update description
1 parent b2f0910 commit f4c1e49

File tree

6 files changed

+26
-2
lines changed

6 files changed

+26
-2
lines changed

.docs/images/app_url.png

146 KB
Loading

.docs/images/hook_url.png

253 KB
Loading

.docs/images/netlify_plugin.png

201 KB
Loading

.docs/images/netlify_settings.png

131 KB
Loading

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,30 @@
11
[[_TOC_]]
22

3-
# Deploy Netlify Plugin
3+
# About plugin
4+
5+
Netlify is the platform for building highly-performant and dynamic websites, e-commerce stores and web applications. With this plugin, you can easily trigger Netlify builds within Content Object changes on form submission. You will also be able to quickly navigate to your Netlify pages from the Flotiq content editor.
6+
7+
## Plugin outcome
8+
9+
In the sidebar of the Content Object form, you will see a panel with the Netlify build buttons. Once you click the button, a link to preview the page will appear below the button.
10+
11+
<img src=".docs/images/netlify_plugin.png" alt="plugin-item" width="1000"/>
12+
13+
## Configuring plugin
14+
15+
To manage a plugin, you must first add it to your plugins. Click the "+" icon to add the plugin to your library and click the "Manage" button. It will open the plugin settings.
16+
17+
<img src=".docs/images/netlify_settings.png" alt="plugin-settings" width="700"/>
18+
19+
To complete the form, you must log in to your Netlify account. In the app's general data, under the app name, you'll find the `Build Instance URL`.
20+
21+
<img src=".docs/images/app_url.png" alt="instance-url" width="700"/>
22+
23+
To find `Build Webhook URL` go to `Site Configuration` -> `Build & deploy` -> `Build hooks`. You need to add a build hook and copy the provided URL.
24+
25+
<img src=".docs/images/hook_url.png" alt="hook-url" width="1000"/>
26+
27+
# Development
428

529
## Quick start
630

plugin-manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"id": "flotiq.deploy-netlify",
33
"name": "Deploy Netlify",
4-
"description": "Integration with Netlify",
4+
"description": "Integration with Netlify deploy. With this plugin, you can easily trigger Netlify builds within Content Object changes on form submission. You will also be able to quickly navigate to your Netlify pages from the Flotiq content editor.",
55
"version": "1.1.0",
66
"repository": "https://github.com/flotiq/flotiq-ui-plugin-deploy-netlify",
77
"url": "https://localhost:3053/index.js",

0 commit comments

Comments
 (0)