Skip to content

Commit 5844488

Browse files
cloudjumpercatCopilotlena-larionova
authored
feat(portal): Reply to and from FAQ (#4858)
* reply to and from FAQ Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Add API instructions, fix alt text Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> * Add email icon, add API steps Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * remove icon Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * please vale Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> --------- Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
1 parent 75620ee commit 5844488

3 files changed

Lines changed: 87 additions & 34 deletions

File tree

app/_includes/faqs/portal-email.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
To customize the reply-to and from, do the following in the {{site.konnect_short_name}} UI:
2+
1. Set up a [custom domain](/dev-portal/custom-domains/) in {{site.dev_portal}}.
3+
1. In the Portal Editor, navigate to the email settings.
4+
1. Click **Email notification settings**.
5+
1. Enter your from name and email.
6+
Reply-to email is optional.
7+
8+
Alternatively, you can use the {{site.dev_portal}} API:
9+
1. Send a POST request to the [`/portals/{portalId}/custom-domain` endpoint](/api/konnect/portal-management/v3/#/operations/create-portal-custom-domain):
10+
{% capture create_custom_domain %}
11+
<!--vale off-->
12+
{% konnect_api_request %}
13+
url: /v3/portals/$DEV_PORTAL_ID/custom-domain
14+
method: POST
15+
body:
16+
hostname: example.com
17+
enabled: true
18+
ssl: {}
19+
{% endkonnect_api_request %}
20+
<!--vale on-->
21+
{% endcapture %}
22+
{{ create_custom_domain | indent: 3 }}
23+
24+
2. Send a POST request to the [`/portals/{portalId}/email-config` endpoint](/api/konnect/portal-management/v3/#/operations/create-portal-email-config):
25+
{% capture create_email_config %}
26+
<!--vale off-->
27+
{% konnect_api_request %}
28+
url: /v3/portals/$DEV_PORTAL_ID/email-config
29+
method: POST
30+
body:
31+
domain_name: example.com
32+
from_name: KongAir
33+
from_email: user@example.com
34+
reply_to_email: admin@example.com
35+
{% endkonnect_api_request %}
36+
<!--vale on-->
37+
{% endcapture %}
38+
{{ create_email_config | indent: 3 }}

app/_landing_pages/dev-portal/customizations/dev-portal-customizations.yaml

Lines changed: 48 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
metadata:
2-
title: "Dev Portal customizations"
2+
title: "{{site.dev_portal}} customizations"
33
content_type: landing_page
4-
description: Customize the look, structure, and access of your Dev Portal with flexible page controls and branding options
4+
description: Customize the look, structure, and access of your {{site.dev_portal}} with flexible page controls and branding options
55
products:
66
- dev-portal
7+
works_on:
8+
- konnect
79
breadcrumbs:
810
- /dev-portal/
911
rows:
1012

1113
- header:
1214
type: h1
13-
text: "Dev Portal customizations"
14-
sub_text: Customize the look, structure, and access of your Dev Portal with flexible page controls and branding options
15+
text: "{{site.dev_portal}} customizations"
16+
sub_text: Customize the look, structure, and access of your {{site.dev_portal}} with flexible page controls and branding options
1517

1618
- columns:
1719
- blocks:
@@ -20,14 +22,14 @@ rows:
2022
blocks:
2123
- type: text
2224
text: |
23-
You can customize your Dev Portals with the following features:
25+
You can customize your {{site.dev_portal}}s with the following features:
2426
- Configure layout, navigation, branding, and domain settings.
2527
- Build content-rich pages with Markdown Components, nest information, and reuse snippets.
2628
- Manage page visibility, publishing workflow, and SEO metadata.
2729
- Customize global appearance, apply custom CSS, and set up menus and navigation structures.
2830
- Set up and manage custom domains, SSL certificates, and URL paths.
2931
30-
The preview will automatically show what your page should look like when developers view your Dev Portal. In the event that it fails to refresh after editing the page, there is a refresh button next to the generated URL at the bottom.
32+
The preview will automatically show what your page should look like when developers view your {{site.dev_portal}}. In the event that it fails to refresh after editing the page, there is a refresh button next to the generated URL at the bottom.
3133
3234
There are three icons above **Preview** that allow you to test adaptive designs in some predefined viewports:
3335
* Desktop
@@ -48,12 +50,12 @@ rows:
4850
blocks:
4951
- type: text
5052
text: |
51-
In your Dev Portal, you can create pages that contain content such as text, buttons, tabs, and more.
52-
Pages are used to convey information about your API and Dev Portal to users.
53+
In your {{site.dev_portal}}, you can create pages that contain content such as text, buttons, tabs, and more.
54+
Pages are used to convey information about your API and {{site.dev_portal}} to users.
5355
They are highly customizable using Markdown Components (MDC), allowing you to create nested page structures to organize pages and generate URLs or slugs.
5456
You can also stage new pages or restrict access to logged-in developers by using visibility controls and publishing status.
5557
56-
To configure pages and content, navigate to your Dev Portal in {{site.konnect_short_name}} and click **Portal Editor** in the sidebar.
58+
To configure pages and content, navigate to your {{site.dev_portal}} in {{site.konnect_short_name}} and click **Portal Editor** in the sidebar.
5759
In the Portal Editor sidebar, click the folder icon.
5860
- blocks:
5961
- type: image
@@ -67,25 +69,25 @@ rows:
6769
config:
6870
title: Pages and content
6971
description: |
70-
Create pages in your Dev Portal to share API information with users. Pages support text, buttons, tabs, and more using Markdown Components (MDC). Organize them in nested structures, control visibility, stage drafts, and customize URLs.
72+
Create pages in your {{site.dev_portal}} to share API information with users. Pages support text, buttons, tabs, and more using Markdown Components (MDC). Organize them in nested structures, control visibility, stage drafts, and customize URLs.
7173
icon: /assets/icons/markdown.svg
7274
cta:
7375
url: /dev-portal/pages-and-content/
7476
- blocks:
7577
- type: card
7678
config:
77-
title: Dev Portal MDC docs
79+
title: "{{site.dev_portal}} MDC docs"
7880
description: |
79-
Create a Dev Portal tailored to your organization with flexible layouts, customizable components, and brand-aligned design elements.
81+
Create a {{site.dev_portal}} tailored to your organization with flexible layouts, customizable components, and brand-aligned design elements.
8082
icon: /assets/icons/code.svg
8183
cta:
8284
url: https://portaldocs.konghq.com/
8385
- blocks:
8486
- type: card
8587
config:
86-
title: Dev Portal global settings
88+
title: "{{site.dev_portal}} global settings"
8789
description: |
88-
Make global changes such as naming your portal, setting the display name used for SEO and page titles. Configure custom domains and review audit logs specific to your Dev Portal.
90+
Make global changes such as naming your portal, setting the display name used for SEO and page titles. Configure custom domains and review audit logs specific to your {{site.dev_portal}}.
8991
icon: /assets/icons/dev-portal.svg
9092
cta:
9193
url: /dev-portal/portal-settings/
@@ -94,8 +96,8 @@ rows:
9496
config:
9597
title: VS Code extension
9698
description: |
97-
Edit and view your Dev Portal pages in real-time in Visual Studio Code.
98-
Integrates with the {{site.konnect_short_name}} API and kongctl to securely manage Dev Portal content.
99+
Edit and view your {{site.dev_portal}} pages in real-time in Visual Studio Code.
100+
Integrates with the {{site.konnect_short_name}} API and kongctl to securely manage {{site.dev_portal}} content.
99101
icon: /assets/icons/vscode.png
100102
cta:
101103
url: https://marketplace.visualstudio.com/items?itemName=konghq.vscode-konnect-dev-portal-toolkit
@@ -110,8 +112,8 @@ rows:
110112
blocks:
111113
- type: text
112114
text: |
113-
Appearance settings are applied globally to all pages in your Dev Portal. For advanced needs, you can also create custom CSS that applies custom styles to your Dev Portal. Custom CSS provides global customization to all pages in Dev Portal.
114-
To configure appearance settings, navigate to your Dev Portal in {{site.konnect_short_name}} and click **Portal Editor** in the sidebar. In the Portal Editor sidebar, click the paint bucket icon.
115+
Appearance settings are applied globally to all pages in your {{site.dev_portal}}. For advanced needs, you can also create custom CSS that applies custom styles to your {{site.dev_portal}}. Custom CSS provides global customization to all pages in {{site.dev_portal}}.
116+
To configure appearance settings, navigate to your {{site.dev_portal}} in {{site.konnect_short_name}} and click **Portal Editor** in the sidebar. In the Portal Editor sidebar, click the paint bucket icon.
115117
116118
Basic appearance settings quickly create basic styles for your default Portal template:
117119
- type: table
@@ -129,27 +131,27 @@ rows:
129131
- setting: Portal logo
130132
description: Automatically used in the header and footer menu sections to ensure consistent branding across pages.
131133
- setting: Favicon
132-
description: Icon displayed in the browser tab and Favorites for Dev Portal visitors.
134+
description: Icon displayed in the browser tab and Favorites for {{site.dev_portal}} visitors.
133135
- blocks:
134136
- type: image
135137
config:
136138
url: /assets/images/dev-portal/dev-portal-appearance.png
137139
alt_text: "KongAir Dev Portal"
138140
- header:
139141
type: h2
140-
text: "Dev Portal navigation"
142+
text: "{{site.dev_portal}} navigation"
141143
columns:
142144
- blocks:
143145
- type: structured_text
144146
config:
145147
blocks:
146148
- type: text
147149
text: |
148-
You can configure the main menu, footer, and footer bottom navigation menus in your Dev Portal.
149-
To configure navigation settings, navigate to your Dev Portal in {{site.konnect_short_name}} and click **Portal Editor** in the sidebar.
150+
You can configure the main menu, footer, and footer bottom navigation menus in your {{site.dev_portal}}.
151+
To configure navigation settings, navigate to your {{site.dev_portal}} in {{site.konnect_short_name}} and click **Portal Editor** in the sidebar.
150152
In the Portal Editor sidebar, click the menu tree icon.
151153
152-
* **Main menu**: Main menus are a flat list of links that will be added to the header of every page in your Dev Portal. These titles and links will be spaced evenly horizontally. You can also add external links to all Dev Portal menu items either using the {{site.konnect_short_name}} UI or the [`/portals/{portalId}/customization` endpoint](/api/konnect/portal-management/v3/#/operations/update-portal-customization).
154+
* **Main menu**: Main menus are a flat list of links that will be added to the header of every page in your {{site.dev_portal}}. These titles and links will be spaced evenly horizontally. You can also add external links to all {{site.dev_portal}} menu items either using the {{site.konnect_short_name}} UI or the [`/portals/{portalId}/customization` endpoint](/api/konnect/portal-management/v3/#/operations/update-portal-customization).
153155
* **Footer menu sections**: Footer menus allow you to create a set of columns with links for global navigation. Select **Footer Sections Menu** from the dropdown list to begin creating your menus. Footer sections create vertical columns across the bottom of every page, with the logo from [Appearance](#appearance) on the left side. We recommend creating your desired footer sections before creating footer menu items. Footer menu items are links to any URL you prefer, with a title to be displayed. Items must specify a footer menu section.
154156
* **Footer bottom menu**: Footer bottom menu is a flat list of links that will be added to the bottom of every page. Footer bottom menus are placed below footer menu sections.
155157
- blocks:
@@ -168,7 +170,7 @@ rows:
168170
blocks:
169171
- type: text
170172
text: |
171-
The API specification settings allow you to control how developers can interact with your API specs in your Dev Portal. To configure API spec settings, navigate to your Dev Portal in {{site.konnect_short_name}} and click **Portal Editor** in the sidebar. In the Portal Editor sidebar, click the code brackets icon.
173+
The API specification settings allow you to control how developers can interact with your API specs in your {{site.dev_portal}}. To configure API spec settings, navigate to your {{site.dev_portal}} in {{site.konnect_short_name}} and click **Portal Editor** in the sidebar. In the Portal Editor sidebar, click the code brackets icon.
172174
173175
The following table describes the API spec settings you can configure:
174176
- blocks:
@@ -181,7 +183,7 @@ rows:
181183
key: description
182184
rows:
183185
- setting: Show Try it
184-
description: Enable in-browser testing for your APIs. All linked gateways must have the CORS plugin configured. For more information, see [Allow developers to try requests from the Dev Portal spec renderer](/catalog/apis/#allow-developers-to-try-requests-from-the-dev-portal-spec-renderer).
186+
description: Enable in-browser testing for your APIs. All linked gateways must have the CORS plugin configured. For more information, see [Allow developers to try requests from the {{site.dev_portal}} spec renderer](/catalog/apis/#allow-developers-to-try-requests-from-the-dev-portal-spec-renderer).
185187
- setting: Show Try it in Insomnia
186188
description: Enables users to open the API spec in [Insomnia](/insomnia/) to explore and send requests with the native client.
187189
- setting: Continuous scroll
@@ -216,7 +218,7 @@ rows:
216218
* Account access rejected
217219
* Account access revoked
218220
219-
To configure email customization settings, go to your Dev Portal, click **Portal Editor**, and then click the **Email** icon in the sidebar.
221+
To configure email customization settings, go to your {{site.dev_portal}}, click **Portal Editor**, and then click the **Email** icon in the sidebar.
220222
221223
In the customization settings, you can use variables. For example, `{% raw %}{{application_name}}{% endraw %}` will be replaced with the name of the application in the email.
222224
@@ -243,17 +245,17 @@ rows:
243245
- variable: "<code>&#123;&#123;credential_expires_at&#125;&#125;</code>"
244246
description: "The date when the [key auth credential expires](/dev-portal/auth-strategies/#configure-the-key-auth-strategy)."
245247
- variable: "<code>&#123;&#123;dev_portal_reply_to&#125;&#125;</code>"
246-
description: The Dev Portal reply-to email address.
248+
description: The {{site.dev_portal}} reply-to email address.
247249
- variable: "<code>&#123;&#123;developer_email&#125;&#125;</code>"
248250
description: The email address of the developer.
249251
- variable: "<code>&#123;&#123;developer_fullname&#125;&#125;</code>"
250252
description: The full name of the developer.
251253
- variable: "<code>&#123;&#123;developer_status&#125;&#125;</code>"
252-
description: The Dev Portal status of a developer. For example, \"approved\", \"pending\", or \"revoked\".
254+
description: The {{site.dev_portal}} status of a developer. For example, \"approved\", \"pending\", or \"revoked\".
253255
- variable: "<code>&#123;&#123;portal_display_name&#125;&#125;</code>"
254-
description: The display name of the Dev Portal.
256+
description: The display name of the {{site.dev_portal}}.
255257
- variable: "<code>&#123;&#123;portal_domain&#125;&#125;</code>"
256-
description: The URL of the Dev Portal.
258+
description: The URL of the {{site.dev_portal}}.
257259
- header:
258260
type: h3
259261
text: "Customize the email domain"
@@ -264,8 +266,8 @@ rows:
264266
blocks:
265267
- type: text
266268
text: |
267-
If you want to change the from and reply-to email domains, you can configure a different domain through Dev Portal settings.
268-
Navigate to your Dev Portal, click **Settings** in the sidebar and click the **Custom domains** tab. Click **New email domain** and configure the settings.
269+
If you want to change the from and reply-to email domains, you can configure a different domain through {{site.dev_portal}} settings.
270+
Navigate to your {{site.dev_portal}}, click **Settings** in the sidebar and click the **Custom domains** tab. Click **New email domain** and configure the settings.
269271
270272
Once you've added your new domain, you must add the CNAME records to your DNS server.
271273
@@ -278,7 +280,19 @@ rows:
278280
config:
279281
title: Custom domains
280282
description: |
281-
Set up custom URLs for your Dev Portal. Custom URLs require DNS setup and your portal’s default URL.
283+
Set up custom URLs for your {{site.dev_portal}}.
284+
Custom URLs require DNS setup and your portal’s default URL.
282285
icon: /assets/icons/domain.svg
283286
cta:
284-
url: /dev-portal/custom-domains/
287+
url: /dev-portal/custom-domains/
288+
289+
- header:
290+
text: "Frequently asked questions"
291+
type: h2
292+
columns:
293+
- blocks:
294+
- type: faqs
295+
config:
296+
- q: How do I customize the reply-to and from for {{site.dev_portal}} emails?
297+
a: |
298+
{% include faqs/portal-email.md %}

app/assets/icons/email.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)