Skip to content

Commit ddda926

Browse files
committed
draft complete
1 parent 50508b5 commit ddda926

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Your API Management service includes a built-in, always up-to-date, **managed**
4444
> The managed developer portal receives and applies updates automatically. Changes that you've saved but not published to the developer portal remain in that state during an update.
4545
4646
## <a name="managed-vs-self-hosted"></a> Options to extend portal functionality
47-
In some cases you might need functionality beyond the customization and styling options supported in the managed developer portal. If you need to implement custom logic, which isn't supported out-of-the-box, you have [several options](developer-portal-extend-custom-functionality.md):
47+
In some cases you might need functionality beyond the customization and styling options provided in the managed developer portal. If you need to implement custom logic, which isn't supported out-of-the-box, you have [several options](developer-portal-extend-custom-functionality.md):
4848
* [Add custom HTML](developer-portal-extend-custom-functionality.md#use-custom-html-code-widget) directly through a developer portal widget designed for small customizations - for example, add HTML for a form or to embed a video player. The custom code is rendered in an inline frame (iframe).
4949
* [Create and upload a custom widget](developer-portal-extend-custom-functionality.md#create-and-upload-custom-widget) to develop and add more complex custom portal features.
5050
* [Self-host the portal](developer-portal-self-host.md) by cloning and modifying the portal's codebase, available on [GitHub](https://github.com/Azure/api-management-developer-portal). When you self-host the portal, you have complete flexibility but become its maintainer and you're responsible for its upgrades. Azure Support's assistance is limited only to the basic setup of self-hosted portals.

articles/api-management/developer-portal-extend-custom-functionality.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ The managed developer portal includes a **Custom HTML code** widget that enables
9292
* **`app`** - Code for the widget component that visitors to the published developer portal see and interact with
9393
* **`editor`** - Code for the widget component that you use in the administrative interface of the developer portal to edit widget settings
9494
95-
The `values.ts` file contains the default values and types of the widget's custom properties.
95+
The `values.ts` file contains the default values and types of the widget's custom properties you can enable for editing.
9696
9797
:::image type="content" source="media/developer-portal-extend-custom-functionality/widget-custom-properties.png" alt-text="Screenshot of custom properties page in developer portal.":::
9898
@@ -121,10 +121,10 @@ The custom widget is now deployed to your developer portal. Using the portal's a
121121
122122
### Publish the developer portal
123123
124-
After you configure the widget and verify its functionality, [republish the portal](api-management-howto-developer-portal-customize.md#publish) to make the widget available in production.
124+
After you configure the widget in the administrative interface, [republish the portal](api-management-howto-developer-portal-customize.md#publish) to make the widget available in production.
125125
126126
> [!NOTE]
127-
> * Widget code updates you deploy aren't used in production until you republish the developer portal.
127+
> * If you deploy updated widget code at a later date, the widget used in production doesn't update until you republish the developer portal.
128128
> * The widget's compiled code is associated with a specific portal *revision*. If you make a previous portal revision current, the custom widget associated with that revision is used.
129129
130130
### Widget templates
@@ -137,9 +137,9 @@ We provide templates for the following technologies you can use for the widget:
137137
138138
All templates are based on the TypeScript programming language.
139139
140-
The React template contains prepared custom hooks in `hooks.ts` file and established providers for sharing context through the component tree with dedicated `useSecrets`, `useValues`, and `useEditorValues` hooks.
140+
The React template contains prepared custom hooks in the `hooks.ts` file and established providers for sharing context through the component tree with dedicated `useSecrets`, `useValues`, and `useEditorValues` hooks.
141141
142-
### Implement a custom widget with another framework
142+
### Using another framework
143143
144144
To implement your widget using another JavaScript UI framework and libraries, you need to set up the project yourself with the following guidelines:
145145
@@ -156,7 +156,7 @@ This package contains a set of tools to help you develop your custom widget and
156156
157157
#### `@azure/api-management-custom-widgets-tools/getValues`
158158
159-
Function that returns JSON object containing the values you've set in the widget editor combined with default values, passed as an argument.
159+
Function that returns a JSON object containing the values you've set in the widget editor combined with default values, passed as an argument.
160160
161161
```JavaScript
162162
Import {getValues} from "@azure/api-management-custom-widgets-tools/getValues"
@@ -209,7 +209,7 @@ It accepts three arguments by default:
209209

210210
This function is used internally in templates. In most implementations you shouldn't need it otherwise.
211211

212-
This function returns all data passed to your custom widget from the developer portal. It contains other pieces of data that might be useful in debugging or in more advanced scenarios. This API is expected to change with potential breaking changes. It returns a JSON object that contains the following keys:
212+
This function returns all data passed to your custom widget from the developer portal. It contains other data that might be useful in debugging or in more advanced scenarios. This API is expected to change with potential breaking changes. It returns a JSON object that contains the following keys:
213213

214214
* `values` - All the values you've set in the editor, the same object that is returned by `getEditorData`
215215

0 commit comments

Comments
 (0)