azure-sdk-for-java icon indicating copy to clipboard operation
azure-sdk-for-java copied to clipboard

Sync reference from MS docs to GitHub pages

Open chenrujun opened this issue 2 years ago • 0 comments

Context

This is next step of #27570.

Now we have 2 places to hold Spring Cloud Azure reference doc:

  1. MS docs:
    1. URL: https://docs.microsoft.com/en-us/azure/developer/java/spring-framework/
    2. GiHub Repo: https://github.com/MicrosoftDocs/azure-dev-docs-pr
  2. GitHub pages:
    1. URL https://microsoft.github.io/spring-cloud-azure/current/reference/html/index.html
    2. GitHub repo: https://github.com/microsoft/spring-cloud-azure

Goal

Use this issue to track the reference doc sync task for each release of Spring Cloud Azure.

Solution

From 4.3.0, follow this workflow to update reference doc:

  1. For developers who want to update reference doc:

    1. Create draft PR in MS docs repo (MicrosoftDocs/azure-dev-docs-pr)
    2. Add the PR in to current issue's Tasks section. Make sure your PR is tracked and will be synced to GitHub pages repo by scrum master.
    3. Corporate with @KarlErickson about your PR, make the PR approved.
  2. For scrum master:

    1. When release finished, make all related PRs merged in MS docs repo.
    2. Sync file changes from MS docs repo (MicrosoftDocs/azure-dev-docs-pr) to GitHub pages repo (microsoft/spring-cloud-azure).

Tasks

chenrujun avatar Jun 01 '22 01:06 chenrujun