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

Update network-topology-and-connectivity guidance with Hybrid connect… #1324

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

aarthiem
Copy link
Contributor

@aarthiem aarthiem commented May 7, 2024

…ivity details using Express Routes

Before selecting the "Create pull request" button:

  1. Enter a meaningful title above^, using a prefix if necessary and keywords "New" or "Update" indicating the nature of changes.

  2. Describe the summary, scope, and intent of this PR:
    As part of the overall resiliency program, we are adding details about resiliency best practices on Express Routes for hybrid connectivity.

  3. Insert links(s) to any related work item(s) or supporting detail: https://dev.azure.com/CSUSolEng/Azure%20Infra%20Networking/_workitems/edit/32583

AFTER YOUR PR HAS BEEN CREATED, expand this section for tips and additional instructions.

These are common guidelines for contributions across the repos managed by the Cloud Architecture Content Team (CACT). Some repositories may have additional specific requirements that are not listed here.

Guidance for all contributors

Topic Guidance
Draft PR If your PR will be a work-in-progress for more than a day or two, select the Convert to draft link in the upper right of the page (under Reviewers) to change it to a draft. For future reference, you can also do this using the Create pull request button drop-down during PR creation.
ms.date metadata
  • Don't update an article's "ms.date" metadata property unless you've done a full freshness review of the content. A full freshness review includes changes required to correct or improve the full technical accuracy of the article.
  • Don't update "ms.date" if you're doing targeted changes to improve non-technical aspects of the article, such as editorial quality, art improvements, article template alignment, etc.
  • If you've changed any "ms.date" properties for work that wasn't part of full review for freshness, please reset them to their previous value.
Placement and linking If you're creating a new article or articles, include updates to the related TOC.yml file to propose where the article(s) should be placed. Also consider other places within the document set where it would be beneficial to cross-reference and link to your new article(s).
PR build After you open your PR, and for each successive commit that you push to your branch, the publishing platform will run validation on the files in your pull request. A summary of the build results for each file will be inserted inline into your pull request, which includes any build suggestions/warnings/errors. PRs cannot be merged until all build errors and most warnings are resolved.
Publishing Following a successful merge, most repos publish to the live site at least once per (business) day, usually around 10am Pacific.
Additional resources

Additional guidance for private repos and internal contributors

Topic Guidance
PR size If your PR is more than ~5 lines of changes, or you'd like for the changes to go through editorial or larger review, open a contribution request at https://aka.ms/Contribution and include a link to the PR in response #8. Once it's processed, you'll be notified of the next steps.
PR title prefix Select the Edit button to the right of the PR title if you need to revise it. The following prefixes are reserved for specific contribution types:

  • [Quality Check] - maintenance work related to content quality (edit passes, art improvements, template alignment)
  • [LinkFix] - recurring/adhoc PRs to correct link URLs
  • [Pipeline] - new/updated contributor success pipeline content
  • [WIP] - a work-in-progress draft requiring several days/weeks
PR preview Following successful build of your PR, publishable files will also include Preview URL links to staged previews of your new/updated articles. Be sure to review these for verification of your intended contributions, or to send to other internal contributors for review.
PR sign-off (public repo) If an article you own is updated in a public repo PR, you are responsible for sign-off. You will be automatically notified via email. The PR will not be merged until you've had a chance to review and sign-off.
PR sign-off (private repo) After you've completed your proposed changes, addressed build warnings, and completed all review work, you can begin the sign-off process for review and merge:

  1. If your PR is in draft mode, remove "[WIP]" from the title and select Ready for review button at the bottom of the PR.
  2. Enter "#sign-off" in a new comment. This comment indicates that you're confident the work meets or exceeds Microsoft's standards for publication, and will trigger the review process.
  3. Your PR may be selected for initial review by the CACT. Following CACT review, you may receive questions or requests for additional changes. You should have initial feedback from CACT review within a few business days. If you have an urgent request or need to contact the team, please mention @MicrosoftDocs/cloud-architecture-content-team-pr-reviewers in your PR and someone will get back to you. After CACT review is complete, a CACT #sign-off will be added.
  4. Final review/merge is done by the PR review team. The PR team may also respond with feedback, categorized as "Blocking" (requires action from you), or "Non-blocking" (to be addressed in a future PR).
Additional resources

Copy link
Contributor

@aarthiem : Thanks for your contribution! The author(s) have been notified to review your proposed change.

Copy link
Contributor

Learn Build status updates of commit e80fc24:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/scenarios/app-platform/api-management/network-topology-and-connectivity.md ⚠️Warning Details

docs/scenarios/app-platform/api-management/network-topology-and-connectivity.md

  • Line 28, Column 157: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/azure/expressroute/designing-for-high-availability-with-expressroute' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 28, Column 157: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/azure/expressroute/designing-for-high-availability-with-expressroute' will be broken in isolated environments. Replace with a relative link.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@Jak-MS
Copy link
Contributor

Jak-MS commented May 7, 2024

@MicrosoftDocs/patterns-and-practices-team-pr-reviewers

  • Can you review this PR?
  • IMPORTANT: When this content is ready to merge, you must add #sign-off in a comment or the approval may get overlooked.

NOTE: The validation issues around the links will need to be addressed before we can merge. (hint: remove https://learn.microsoft.com/en-us from the urls.

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

@prmerger-automator prmerger-automator bot added the aq-pr-triaged tracking label for the PR review team label May 7, 2024
@Jak-MS
Copy link
Contributor

Jak-MS commented May 13, 2024

#label:"pending-content-team/business-approval"

Copy link

This pull request has been inactive for 14 days. If you are finished with your changes, don't forget to sign off. For instructions, see the contributor guide.
Cloud Adoption Framework team
Contact Us

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