Skip to content

Commit 538dba6

Browse files
feat(dev-portal): Portal Editor updates and consolidate Portal customization pages (#3294)
* Draft new Portal Editor changes Signed-off-by: Diana <[email protected]> * Consolidate customization pages, add redirects Signed-off-by: Diana <[email protected]> * Fix screenshots Signed-off-by: Diana <[email protected]> --------- Signed-off-by: Diana <[email protected]> Co-authored-by: Jason Harmon <[email protected]>
1 parent 390df58 commit 538dba6

File tree

14 files changed

+239
-245
lines changed

14 files changed

+239
-245
lines changed

app/_indices/dev-portal.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,6 @@ sections:
3232
- path: /dev-portal/customizations/dev-portal-customizations/
3333
- path: /dev-portal/pages-and-content/
3434
- path: /dev-portal/custom-domains/
35-
- path: /dev-portal/customization-settings/
36-
- path: /dev-portal/portal-customization/
3735
- title: Access and approvals
3836
items:
3937
- path: /dev-portal/team-mapping/

app/_landing_pages/dev-portal.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,6 @@ rows:
121121
url: "/dev-portal/pages-and-content/"
122122
- text: Custom domains
123123
url: "/dev-portal/custom-domains/"
124-
- text: Customization settings
125-
url: "/dev-portal/portal-customization/"
126124
- text: Dev Portal settings
127125
url: "/dev-portal/portal-settings/"
128126
- blocks:

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

Lines changed: 223 additions & 40 deletions
Large diffs are not rendered by default.

app/_redirects

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,7 @@
139139
/dev-portal/application-registration/ /dev-portal/self-service/
140140
/dev-portal/access-and-approval/ /dev-portal/self-service/
141141
/dev-portal/publishing/ /catalog/apis/
142+
/dev-portal/portal-customization/ /dev-portal/customizations/dev-portal-customizations/
142143

143144

144145
# Gateway LTS
334 KB
Loading
-122 KB
Loading
321 KB
Loading

app/catalog/apis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@ Publishing an API makes it available to one or more [Dev Portals](/dev-portal/).
339339
Publishing an API requires you to have the [`Product Publisher` {{site.konnect_short_name}} role](/konnect-platform/teams-and-roles/#dev-portal).
340340

341341
{:.info}
342-
> * The visibility of [pages](/dev-portal/pages-and-content/) and [menus](/dev-portal/portal-customization/) is configured independently from APIs, maximizing your flexibility.
342+
> * The visibility of [pages](/dev-portal/pages-and-content/) and [menus](/dev-portal/customizations/dev-portal-customizations/) is configured independently from APIs, maximizing your flexibility.
343343
> * {% new_in 3.6 %} An API must be linked to a {{site.konnect_short_name}} Gateway Service to be able to restrict access to your API with authentication strategies.
344344
345345
With the appropriate [security](/dev-portal/security-settings/) and [access and approval](/dev-portal/self-service/) settings, you can publish an API securely to the appropriate audience. The following table describes various Dev Portal access control scenarios and their settings:

app/dev-portal/custom-domains.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@ works_on:
1818
description: "Use a custom URL for Dev Portal."
1919

2020
related_resources:
21-
- text: Portal customization reference
22-
url: /dev-portal/portal-customization/
2321
- text: Pages and content
2422
url: /dev-portal/pages-and-content/
2523
- text: Dev Portal settings

app/dev-portal/pages-and-content.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,6 @@ faqs:
8080
related_resources:
8181
- text: Dev Portal Markdown components reference
8282
url: https://portaldocs.konghq.com/
83-
- text: Portal customization reference
84-
url: /dev-portal/portal-customization/
8583
- text: Custom domains
8684
url: /dev-portal/custom-domains/
8785
- text: About Dev Portal customizations
@@ -97,6 +95,8 @@ In your Dev Portal, you can create pages that contain content such as text, butt
9795

9896
You can create multiple pages in the Dev Portal, similar to how a website is structured. Pages can contain text and other objects, like containers and buttons. To get started creating pages, navigate to your Dev Portal and click **Portal Editor** in the sidebar. Pages are built using Markdown Components (MDC). Additional documentation on syntax, as well as tools for generating components, are available on a [dedicated MDC site](https://portaldocs.konghq.com/).
9997

98+
Custom pages allow you to define a page structure/tree that organizes your pages and generates the page URL based on page slugs. The generated URL is shown at the bottom of the preview pane.
99+
100100
### Page structure
101101

102102
On the left panel inside the Portal Editor, you'll see a list of pages in your Dev Portal. The name for each page is a `slug`, and will be used to build the URL for that page. You can nest child pages under other pages. If pages are nested, the slugs will be combined to build the URL.

0 commit comments

Comments
 (0)