Skip to content

Commit eac9b17

Browse files
Merge pull request #298004 from dlepow/devtut
[APIM] Update dev portal UX
2 parents fe53753 + 8f278be commit eac9b17

File tree

8 files changed

+14
-13
lines changed

8 files changed

+14
-13
lines changed

articles/api-management/api-management-howto-developer-portal-customize.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: dlepow
66

77
ms.service: azure-api-management
88
ms.topic: tutorial
9-
ms.date: 03/29/2024
9+
ms.date: 04/28/2025
1010
ms.author: danlep
1111
ms.custom: engagement-fy23
1212
---
@@ -28,7 +28,7 @@ In this tutorial, you learn how to:
2828
2929
For more information about developer portal features and options, see [Azure API Management developer portal overview](developer-portal-overview.md).
3030

31-
:::image type="content" source="media/api-management-howto-developer-portal-customize/cover.png" alt-text="Screenshot of the API Management developer portal - administrator mode." border="false":::
31+
:::image type="content" source="media/api-management-howto-developer-portal-customize/cover.png" alt-text="Screenshot of the API Management developer portal - administrator mode." :::
3232

3333
## Prerequisites
3434

@@ -49,6 +49,8 @@ Follow these steps to access the managed version of the developer portal.
4949
It might take a few minutes to enable the developer portal.
5050
1. In the left menu, under **Developer portal**, select **Portal overview**. Then select the **Developer portal** button in the top navigation bar. A new browser tab with an administrative version of the portal will open.
5151

52+
[!INCLUDE [developer-portal-editor-refresh](../../includes/developer-portal-editor-refresh.md)]
53+
5254
## Understand the portal's administrative interface
5355

5456
[!INCLUDE [api-management-developer-portal-editor](../../includes/api-management-developer-portal-editor.md)]
@@ -70,7 +72,7 @@ You'll want to use your own images and other media content in the developer port
7072

7173
A placeholder logo is provided in the top left corner of the navigation bar. You can replace it with your own logo to match your organization's branding.
7274

73-
1. In the developer portal, select the default **Contoso** logo in the top left of the navigation bar.
75+
1. In the developer portal, select the default logo in the top left of the navigation bar.
7476
1. Select **Edit**.
7577
1. In the **Picture** pop-up, under **Main**, select **Source**.
7678
1. In the **Media** pop-up, select one of the following:

articles/api-management/developer-portal-overview.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: dlepow
77

88
ms.service: azure-api-management
99
ms.topic: concept-article
10-
ms.date: 03/29/2024
10+
ms.date: 04/28/2025
1111
ms.author: danlep
1212
---
1313

@@ -76,21 +76,18 @@ The developer portal's administrative interface provides a visual editor for pub
7676

7777
[!INCLUDE [api-management-developer-portal-add](../../includes/api-management-developer-portal-add.md)]
7878

79-
[!INCLUDE [api-management-developer-portal-wordpress](../../includes/api-management-developer-portal-wordpress.md)]
79+
### Pages and layouts
8080

81+
The pre-provisioned content in the developer portal showcases pages with commonly used features. Find them on the **Pages** panel. You can modify the content of these pages or add new ones to suit your needs.
8182

82-
### Layouts and pages
83-
84-
Layouts define how pages are displayed. For example, in the default content, there are two layouts: one applies to the home page, and the other to all remaining pages. You can modify these layouts and add more layouts to suit your needs.
83+
Select **Layouts** on the **Pages** panel to define how pages are displayed. The developer portal comes with a default layout that's applied to the pages. You can modify this layout and add more layouts to suit your needs.
8584

8685
A layout gets applied to a page by matching its URL template to the page's URL. For example, a layout with a URL template of `/wiki/*` is applied to every page with the `/wiki/` segment in the URL: `/wiki/getting-started`, `/wiki/styles`, etc.
8786

8887
In the following image, content belonging to the layout is outlined in blue, while the page-specific content is outlined in red.
8988

9089
:::image type="content" source="media/developer-portal-overview/pages-layouts.png" alt-text="Screenshot of layout content in the developer portal." :::
9190

92-
The pre-provisioned content in the developer portal showcases pages with commonly used features. You can modify the content of these pages or add new ones to suit your needs.
93-
9491
> [!NOTE]
9592
> Due to integration considerations, the following pages can't be removed or moved under a different URL: `/404`, `/500`, `/captcha`, `/change-password`, `/config.json`, `/confirm/invitation`, `/confirm-v2/identities/basic/signup`, `/confirm-v2/password`, `/internal-status-0123456789abcdef`, `/publish`, `/signin`, `/signin-sso`, `/signup`.
9693
@@ -248,7 +245,8 @@ To restore a previous portal revision:
248245
If you want to discard all changes you've made to the developer portal, you can reset the website to its starting state. Resetting the portal deletes any changes you've made to the developer portal pages, layouts, customizations, and uploaded media.
249246

250247
> [!NOTE]
251-
> Resetting the developer portal doesn't delete the published version of the developer portal.
248+
> * Resetting the developer portal doesn't delete the published version of the developer portal.
249+
> * Resetting the portal could update the portal to a newer version of the developer portal codebase with updated components. The placeholder content that appears might also be changed. Developer portal features and customization options remain consistent.
252250
253251
To reset the developer portal:
254252

300 KB
Loading
5.07 KB
Loading
300 KB
Loading
60.4 KB
Loading

includes/developer-portal-editor-refresh.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22
author: dlepow
33
ms.service: azure-api-management
44
ms.topic: include
5-
ms.date: 12/22/2023
5+
ms.date: 04/28/2025
66
ms.author: danlep
77
---
88

99

1010
> [!NOTE]
11-
> We recently improved the portal editor interface to boost your productivity and enhance the interactions with your favorite features and tools. We also redesigned the API and product details widgets to elevate the portal experience for visitors.
11+
> * We're enhancing the developer portal with [Fluent UI Web Components](/fluent-ui/web-components) in the React framework. We're also refreshing the placeholder content displayed when you first open the portal. Your portal's appearance may differ slightly from the screenshots in this article, but the functionality remains consistent.
12+
> * If you're using a version of the portal built on the previous components, you'll see a **Preview new UI design** setting at the bottom of the menu on the left. Enable this setting to try the latest experience.<br/><br/> :::image type="content" source="../articles/api-management/media/api-management-howto-developer-portal-customize/preview-new-ui.png" alt-text="Screenshot of preview toggle in the API Management developer portal.":::
158 KB
Loading

0 commit comments

Comments
 (0)