W 10587060 add configure instuctions gr by glenn-rodgers-sf · Pull Request #477 · mulesoft/docs-api-manager

glenn-rodgers-sf · 2022-11-11T17:03:23Z

https://gus.lightning.force.com/lightning/r/ADM_Work__c/a07EE00000lZdLeYAK/view

tutecano1995

Nice work! Leave some suggestions, feel free to ask me any questions and change the wording

tutecano1995 · 2022-11-14T21:35:06Z

 . Click *Advanced Options*.
 . In *Proxy Version*, select *latest*. +
 This value ensures that your API proxy uses the latest released proxy version.
+If you update proxy version in exchange, return to this step to reconfigure your proxy to the latest version.


This page is for proxy configuration, the proxy version is not the same as the API Asset Version in Exchange. I believe we can leave this page as it is.

I added this because the ticket is originally in reference to the configure page, but was really just providing information about normal API's. I don't think it hurts to have it here.

I believe that they were probably mixing concepts in the ticket. Users can't upload new proxy versions to exchange, we upload them internally and they just see new proxy versions available. Maybe we can rephrase this to something like:

If a new proxy version is available in Anypoint platform, you can return to this step to reconfigure your proxy to the latest version.

tutecano1995 · 2022-11-14T21:44:52Z

 endif::[]

-After you create an API in Anypoint Platform, you configure the version details for the API and then publish it to Anypoint Exchange (Exchange). The API version resides in Exchange, and not in API Manager. However, you then manage this API version from API Manager.
+After an API is created, you can configure version details for the API and publish them to Anypoint Exchange (Exchange). The API asset version resides in Exchange, and not in API Manager. However, you manage the version of an API instance from API Manager. You can create multiple instances and expand the version information to view details about them.


I feel that the sentence is not completely clear.

After an API is created, you can configure version details for the API and publish them to Anypoint Exchange (Exchange)

Maybe we can remove the "After an API is created" part and just say something like:

You can configure the API Asset version details for the API and push it to Anypoint Exchange (Exchange).

Also maybe we can add some link to Exchange documentation. For example to this one:

https://docs.mulesoft.com/exchange/about-sharing-assets

tutecano1995 · 2022-11-14T22:00:24Z

 endif::[]

-After you create an API in Anypoint Platform, you configure the version details for the API and then publish it to Anypoint Exchange (Exchange). The API version resides in Exchange, and not in API Manager. However, you then manage this API version from API Manager.
+After an API is created, you can configure version details for the API and publish them to Anypoint Exchange (Exchange). The API asset version resides in Exchange, and not in API Manager. However, you manage the version of an API instance from API Manager. You can create multiple instances and expand the version information to view details about them.


Also we could expand this part in more details:

However, you manage the version of an API instance from API Manager

Something like:

However, once you [add a new API Instance in API Manager](https://docs.mulesoft.com/api-manager/2.x/create-instance-task), you can change the API Asset version of that API Instance.

I link to exchange in the bottom.

tutecano1995 · 2022-11-14T22:04:09Z

-After you create an API in Anypoint Platform, you configure the version details for the API and then publish it to Anypoint Exchange (Exchange). The API version resides in Exchange, and not in API Manager. However, you then manage this API version from API Manager.
+After an API is created, you can configure version details for the API and publish them to Anypoint Exchange (Exchange). The API asset version resides in Exchange, and not in API Manager. However, you manage the version of an API instance from API Manager. You can create multiple instances and expand the version information to view details about them.

-After setting up an API version for management, you repeat the process to create another instance. Attempting to configure the same version creates another instance of the version. You can create multiple instances and expand the version information to view details about them.


I would not remove this part, maybe we can rephrase and clarify it a bit. But here is where we say that if they create a new API Instance linked to the same Exchange API Asset version, a completely new API Instance will be created in API Manager.

You can create multiple instances and expand the version information to view details about them.

I'm not sure what does "expand the version information to view details about them" mean 🤔

This section still really confuses me as well. I feel like it's clear that creating a new API just creates a new instance then you manage this instance, but I don't know. Let me know what you think about this in the new one.

dhirsch1 · 2022-11-21T20:34:57Z

 endif::[]

-After you create an API in Anypoint Platform, you configure the version details for the API and then publish it to Anypoint Exchange (Exchange). The API version resides in Exchange, and not in API Manager. However, you then manage this API version from API Manager.
+You can configure version details for an existing API and publish them to Anypoint Exchange (Exchange). The API asset version resides in Exchange, and not in API Manager. However, you can create multiple instances of an API and manage their version from API Manager. See xref:create-instance-task.adoc[Adding an API Instance], for information on how to add an API instance to API Manager.


Suggested change

You can configure version details for an existing API and publish them to Anypoint Exchange (Exchange). The API asset version resides in Exchange, and not in API Manager. However, you can create multiple instances of an API and manage their version from API Manager. See xref:create-instance-task.adoc[Adding an API Instance], for information on how to add an API instance to API Manager.

You can configure version details for an existing API and publish them to Anypoint Exchange (Exchange). The API asset version resides in Exchange, and not in API Manager. However, you can create multiple instances of an API and manage their versions from API Manager. See xref:create-instance-task.adoc[Adding an API Instance], for information on how to add an API instance to API Manager.

dhirsch1 · 2022-11-21T20:35:27Z

+
+image::api-settings.png[API Manager administration settings.]
+. Select *Actions* > *Change API specification*.
+. In *Asset version*, Select latest. 


Suggested change

. In *Asset version*, Select latest.

. In *Asset version*, select *latest*.

dhirsch1 · 2022-11-22T21:57:25Z

+In Anypoint Exchange (Exchange), you can add, delete, and deprecate API versions, also known as _Exchange assets_. An API version in Exchange can have its own RAML file, API portal, and URL. See xref:exchange::manage-versions.adoc[Manage Versions] for more information.

-If you add new version details for an API definition and publish them to exchange, the version of your existing API instance does not change automatically. You must change the version of your API instance in API Manager if you want the instance to reflect the latest version. For more information on the differences between and API definition and an API instace, see xref:api-instance-landing-page.adoc[API Instance].
+If you add new version details for an API definition and publish them to exchange, the version of your existing API instance does not change automatically. You must change the version of your API instance in API Manager if you want the instance to reflect the latest version. For more information on API instaces, see xref:api-instance-landing-page.adoc[API Instance].


In line 8, clarify where you are adding the new version details:
" If you use API Manager (or do you use Exchange or both?) to add new version details..."

exchange > Exchange

Typo: instaces

dhirsch1 · 2022-11-22T21:59:49Z

 endif::[]

-You can add, delete, and deprecate API versions, also known as _Exchange assets_, in Anypoint Exchange (Exchange). An API version in Exchange can have its own RAML file, API portal, and URL. See xref:exchange::manage-versions.adoc[Manage Versions] for more information.
+In Anypoint Exchange (Exchange), you can add, delete, and deprecate API versions, also known as _Exchange assets_. An API version in Exchange can have its own RAML file, API portal, and URL. See xref:exchange::manage-versions.adoc[Manage Versions] for more information.


The way you construct the more information text should be consistent. Here you start it with the reference (See xref:exchange::manage-versions.adoc[Manage Versions] for more information.) Later on, you start it with "For more information on..."

It is better to start it with "For more information about..." because users can decide more quickly if they want to look at the reference. Kim wanted us to use "about" instead of "on."

dhirsch1 · 2022-11-22T22:14:12Z

 endif::[]

-In Anypoint Exchange (Exchange), you can add, delete, and deprecate API versions, also known as _Exchange assets_. An API version in Exchange can have its own RAML file, API portal, and URL. See xref:exchange::manage-versions.adoc[Manage Versions] for more information on how to manage API versions in exchange.
+In Anypoint Exchange (Exchange), you can add, delete, and deprecate API versions, also known as _Exchange assets_. An API version in Exchange can have its own RAML file, API portal, and URL. For more information on how to manage API versions in exchange, see xref:exchange::manage-versions.adoc[Manage Versions].


For more information on > For more information about (to follow Kim's edits) (here and in the next paragraph)

exchange > Exchange (here and in the next paragraph)

…b.com/mulesoft/docs-api-manager into W-10587060-add-configure-instuctions-gr

glenn-rodgers-sf added 2 commits November 11, 2022 11:15

added how to reconfigure versions of proxies and APIs

4f7e6c3

Update manage-versions-instances-concept.adoc

0de237c

glenn-rodgers-sf requested review from a team and priyaayyar as code owners November 11, 2022 17:03

Edits for clarity

ddc1a2f

tutecano1995 reviewed Nov 14, 2022

View reviewed changes

glenn-rodgers-sf added 2 commits November 15, 2022 10:36

Added reviewer comments

86027a0

Added engineer review

862ed3f

dhirsch1 reviewed Nov 21, 2022

View reviewed changes

glenn-rodgers-sf added 5 commits November 22, 2022 09:21

Update manage-versions-instances-concept.adoc

c0be1d0

Edited flow of information.

b2a0d75

update

d0bef81

Edits for clarity

819b46f

edits for clarity

b22782e

dhirsch1 reviewed Nov 22, 2022

View reviewed changes

dhirsch1 previously approved these changes Nov 22, 2022

View reviewed changes

Edits to clarify where you add changes.

29fcb88

glenn-rodgers-sf dismissed dhirsch1’s stale review via 29fcb88 November 22, 2022 22:07

dhirsch1 reviewed Nov 22, 2022

View reviewed changes

glenn-rodgers-sf added 2 commits November 22, 2022 16:24

capitalized Exchange

bee1445

Small edit

f3183b1

tutecano1995 previously approved these changes Nov 28, 2022

View reviewed changes

glenn-rodgers-sf and others added 3 commits November 28, 2022 13:58

Merge branch 'v2.x' into W-10587060-add-configure-instuctions-gr

575172f

Remove screenshot

95df880

Merge branch 'W-10587060-add-configure-instuctions-gr' of ssh://githu…

53f1c10

…b.com/mulesoft/docs-api-manager into W-10587060-add-configure-instuctions-gr

glenn-rodgers-sf dismissed tutecano1995’s stale review via 53f1c10 November 28, 2022 20:00

Merge branch 'v2.x' into W-10587060-add-configure-instuctions-gr

01bfa02

dhirsch1 approved these changes Nov 28, 2022

View reviewed changes

glenn-rodgers-sf merged commit 088e0cb into v2.x Nov 28, 2022

glenn-rodgers-sf deleted the W-10587060-add-configure-instuctions-gr branch November 28, 2022 20:48

	You can configure version details for an existing API and publish them to Anypoint Exchange (Exchange). The API asset version resides in Exchange, and not in API Manager. However, you can create multiple instances of an API and manage their version from API Manager. See xref:create-instance-task.adoc[Adding an API Instance], for information on how to add an API instance to API Manager.
	You can configure version details for an existing API and publish them to Anypoint Exchange (Exchange). The API asset version resides in Exchange, and not in API Manager. However, you can create multiple instances of an API and manage their versions from API Manager. See xref:create-instance-task.adoc[Adding an API Instance], for information on how to add an API instance to API Manager.

	. In Asset version, Select latest.
	. In Asset version, select latest.

Conversation

glenn-rodgers-sf commented Nov 11, 2022

Uh oh!

tutecano1995 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dhirsch1 Nov 21, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dhirsch1 Nov 21, 2022 •

edited

Loading