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-17160340-Nav-changes-and-Anypoint-platform-intro-CP #580

Merged
merged 31 commits into from
Nov 21, 2024

Conversation

Crispy-Salesforce
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

tomasperezc
tomasperezc previously approved these changes Nov 11, 2024
* xref:login-platform-from-studio.adoc[]
** xref:set-credentials-in-studio-to.adoc[]

* xref:set-anypoint-platform-cloud.adoc[Set Anypoint Platform Cloud]
Copy link
Contributor

@hannanelson hannanelson Nov 11, 2024

Choose a reason for hiding this comment

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

What does "set" mean in this case? Are you selecting it? Configuring Studio to deploy to it?

Copy link
Contributor

Choose a reason for hiding this comment

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

Consider removing any hard-coded link text that's not different from the H1.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I chose “set” as it is a “general” verb. This is an introduction to the deployment options that Studio offers. Is "Configure" a better option?

** xref:eu-cloud-configuration.adoc[Configure EU Cloud in Studio]
** xref:pce-configuration.adoc[Configure Private Cloud Edition in Studio]
*** xref:pce3-configuration.adoc[Configure PCE 3 in Studio]
**** xref:pce-configuration-macos.adoc[MacOS]
Copy link
Contributor

Choose a reason for hiding this comment

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

Make sure that the H1s are as unique as possible (I'm not sure what they are based on this link text).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK! Thanks!

* xref:login-platform-from-studio.adoc[]
** xref:set-credentials-in-studio-to.adoc[]

* xref:set-anypoint-platform-cloud.adoc[Set Anypoint Platform Cloud]
** xref:deploy-mule-application-task.adoc[Deploy a Mule Application to CloudHub]
** xref:domain-support-concept.adoc[Domain Support]
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you add more context here? I'm not sure what the topic is about based on the title. What is the user value?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I changed the title. Do you mean to add the value for the customer in the title?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes. Domain Support doesn't tell me much about what's included in the topic. The user task seems to be "share global configurations between different Mule applications implementing the same domain"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes! The user task you described is accurate but maybe too long.
What about?:
"Manage Mule Domains Through Global Elements and Configuration XML".
I can't think of a short and sweet title :/
Thanks!

** xref:deploy-mule-application-task.adoc[Deploy a Mule Application to CloudHub]
** xref:domain-support-concept.adoc[Domain Support]
*** xref:domain-studio-tasks.adoc[Design Mule Domains]
** xref:eu-cloud-configuration.adoc[Configure EU Cloud in Studio]
Copy link
Contributor

Choose a reason for hiding this comment

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

This H1 is really different in the topic...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm confused. Do you mean that the configuration of EU Cloud in Studio is really different from configuring Hyperforce or the Studio domains?

Copy link
Contributor

Choose a reason for hiding this comment

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

I mean the hard-coded link text is really different than the H1 in the topic: "Access the EU Control Plane from Anypoint Studio"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes! I'm trying to be consistent with the titles in the nav, at least.

Copy link
Contributor

Choose a reason for hiding this comment

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

OK, but it might be confusing to have the source/destination so different.

Crispy-Salesforce and others added 4 commits November 11, 2024 16:55
Co-authored-by: Hanna Nelson <hanna.nelson@mulesoft.com>
Co-authored-by: Hanna Nelson <hanna.nelson@mulesoft.com>
Co-authored-by: Hanna Nelson <hanna.nelson@mulesoft.com>
Co-authored-by: Hanna Nelson <hanna.nelson@mulesoft.com>
Crispy-Salesforce and others added 3 commits November 11, 2024 16:57
Co-authored-by: Hanna Nelson <hanna.nelson@mulesoft.com>
Co-authored-by: Hanna Nelson <hanna.nelson@mulesoft.com>
@Crispy-Salesforce Crispy-Salesforce marked this pull request as ready for review November 21, 2024 18:11
@Crispy-Salesforce Crispy-Salesforce merged commit 5bc8b98 into v7.20 Nov 21, 2024
5 checks passed
@Crispy-Salesforce Crispy-Salesforce deleted the W-17160340-Group-platform-cloud-settings-CP branch November 21, 2024 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants