Azure / api-management-developer-portal

Developer portal provided by the Azure API Management service.
MIT License
488 stars 318 forks source link

Confusing UX in APIM GUI to view, edit and publish the DevPortal #869

Closed AnRei123 closed 7 months ago

AnRei123 commented 4 years ago

Background information:

Our developers do not need and shall not open the portal in editor mode nor do they need or shall click on the publish portal button. They most of the time only intend how there API changes are reflected within the DevPortal regarding style sheets and functions. Therefore, by default they should use the web URL link to open the DevPortal in reading mode!

For maintaining the portal web pages and the additional content that is provided via the edit mode of the portal, we have dedicated content contributors. Only these content contributors shall open the portal in editing mode and shall publish the portal on demand for any APIM environment.

The edit mode of the new portal does not support all the functions as the reading mode does such as subscribing to products or picking the subscription keys. And the editing mode GUI is disgusting if you just like to view your latest API changes as the tool palette is displayed and you need to keep the CTRL key pressed to use the navigation and interaction elements.

Problem statement:

With the current GUI implementation of the APIM portal, the developer seem to be very confused on how to invoke the portal reading and editing mode and on what publishing the portal effects.

Expected behavior

Is your portal managed or self-hosted?

managed

API Management service name

apiteamplayuxplayground

Environment

ilspiert commented 4 years ago

Agree with that - would also love to have a more consistend solution and only one place. As well having a group/permission to allow publishing/managing the Developer Portal only.

azaslonov commented 4 years ago

Hi @AnRei123 and @fsettele, thank you for your feedback. We understand the problem, we'll see what can be done.

AnRei123 commented 4 years ago

I like to add the following improvement requirements to this issue to also facilitate the work of content contributors:

  1. As a content contributor, I can open the DevPortal in reading mode from the opened DevPortal in editing mode on a new tab card by either clicking on a button or clicking a shortcut.
  2. As a content contributor, I can publish the portal in editing mode via a shortcut w/o the need to navigate to the publish buttons.
  3. As a content contributor, I can open the portal in editing mode directly from my browsers bookmark panel without the need of navigating to the overview page of the APIM portal. And I can configure my bookmark the following that the portal automatically opens on the most frequently used page (APIM wiki, alias "Docs&guidelines).
mrcarlosdev commented 7 months ago

This issue is related to managed developer portal. We advise you to create a Azure support request to get assistance on this issue. Please refer to the below link to create a new Azure support request, Please select Problem Type = "Developer Portal" in the request to route it appropriately.

https://learn.microsoft.com/en-us/azure/azure-portal/supportability/how-to-create-azure-support-request