Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

W-17246664 Enabling API Catalog #373

Open
wants to merge 6 commits into
base: latest
Choose a base branch
from

Conversation

valkyrie69
Copy link
Contributor

Writer's Quality Checklist

Before merging your PR, did you:

  • Run spell checker
  • Run link checker to check for broken xrefs
  • Check for orphan files
  • Perform a local build and do a final visual check of your content, including checking for:
    • Broken images
    • Dead links
    • Correct rendering of partials if they are used in your content
    • Formatting issues, such as:
      • Misnumbered ordered lists (steps) or incorrectly nested unordered lists
      • Messed up tables
      • Proper indentation
      • Correct header levels
  • Receive final review and signoff from:
    • Technical SME
    • Product Manager
    • Editor or peer reviewer
    • Reporter, if this content is in response to a reported issue (internal or external feedback)
  • If applicable, verify that the software actually got released

@valkyrie69 valkyrie69 requested a review from a team as a code owner November 18, 2024 17:33
@valkyrie69 valkyrie69 self-assigned this Dec 4, 2024
include::partial$include-nav-steps-org-admin.adoc[]

. Click *Salesforce*.
. In *Capabilities Managed in Anypoint Platform*, click *Settings* for *Make MuleSoft Anypoint Platform APIs Available in Salesforce*.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right now these options don't seem to match what's in QAX. Is there a new design for this I should be using for the review?

. In *Settings*, select the Anypoint Platform business groups that allow the Salesforce organization to import Anypoint Platform APIs into its API Catalog, and click *Save Settings*.
+
[NOTE]
Within the selected business groups, you can import only APIs that have specs published in Exchange with active instances into Salesforce.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are quite a prerequisites that have to be met for APIs to sync into API Catalog. I wonder if we could be a little less specific here and cross-reference the API Catalog "Before You Begin" (Name and link tbd) content in help.salesforce.com? Something like:
Within the selected business groups, you can sync only APIs from Exchange that have managed instances and meet the prerequisite conditions. For more information, see Salesforce Help.

The alternative might be to duplicate all of the prereqs here, which becomes a maintenance issue. It's a bit of a moving target now.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, import should be changed to sync throughout the content and the UI text.

+
The Salesforce organization administrator can then sync APIs into their catalog.
+
For details about syncing APIs and using API Catalog in Salesforce, see xref:general::api-catalog-in-salesforce.adoc[].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will this link be replaced with a link to the topic in Salesforce Help? I have the planned link, but need to get the topic ID approved by a content strategist before I share it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bjoson-mulesoft Yes, it will need to link to the Salesforce help content.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@valkyrie69, the best link in the Salesforce help will be https://help.salesforce.com/s/articleView?id=platform.api_catalog.htm and the title is API Catalog.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants