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

Add Spring Cloud Azure in each Azure product's MS docs page

Open chenrujun opened this issue 3 years ago • 9 comments

Context

Now in each Azure Product's MS docs, there is no entry for Spring Cloud Azure. For example: In this page: https://docs.microsoft.com/en-us/azure/event-hubs/, there is no link to Spring Cloud Azure. @seanli1988 already created PR:

  • https://github.com/MicrosoftDocs/azure-docs-pr/pull/199915
  • https://github.com/MicrosoftDocs/azure-docs-pr/pull/199911
  • https://github.com/MicrosoftDocs/azure-docs-pr/pull/199916
  • https://github.com/MicrosoftDocs/azure-docs-pr/pull/199912
  • https://github.com/MicrosoftDocs/azure-docs-pr/pull/199910
  • https://github.com/MicrosoftDocs/azure-docs-pr/pull/199907

But after @KarlErickson's review, we found that it's not that simple. We need more investigation about how to add "Spring Cloud Azure" entry in each Azure product's MS docs.

Problem

  1. These PRs are not merged. And there is Check error in these PRs.
  2. Some PR didn't give the best solution. We need more consideration about how to add entry for "Spring on Azure" in each services' MS docs.

Goal

Add Spring Cloud Azure in each Azure product's MS docs page

Solution

Tasks

  • [x] Re-iInvestigate and design how to add "Spring Cloud Azure" in related services' MS docs.

  • [x] Make these PRs merged or closed:

    • [x] https://github.com/MicrosoftDocs/azure-docs-pr/pull/199915
    • [x] https://github.com/MicrosoftDocs/azure-docs-pr/pull/199911
    • [x] https://github.com/MicrosoftDocs/azure-docs-pr/pull/199916
    • [x] https://github.com/MicrosoftDocs/azure-docs-pr/pull/199912
    • [x] https://github.com/MicrosoftDocs/azure-docs-pr/pull/199910
    • [x] https://github.com/MicrosoftDocs/azure-docs-pr/pull/199907

chenrujun avatar Jun 15 '22 01:06 chenrujun

Current status:

Service Name MS docs Update index Update TOC/Quickstart Update TOC/Reference
App Configuration link :x: :x: :x:
Azure AD link :x: :x: :x:
Cosmos DB link :x: :x: :x:
Key Vault link #199907 :x: :x:
Event Hubs link #199912 :x: #199915
Event Hubs (Kafka API) link :x: :x: :x:
Service Bus link #199910 :x: #199910
Storage link :x: #199916 :x:

chenrujun avatar Jul 06 '22 07:07 chenrujun

Here is the list that can add spring-cloud-azure in each Azure Service's MS docs page

  • [x] index.yml (The index pages do not have the uniform contents, so there is no sub items)
  • [x] TOC.yml
    • [x] Quickstarts
    • [x] Tutorial
    • [x] Sample
    • [x] Reference

chenrujun avatar Jul 07 '22 08:07 chenrujun

Link to related PRs:

  • [x] https://github.com/MicrosoftDocs/azure-docs-pr/pull/203989
  • [x] https://github.com/MicrosoftDocs/azure-docs-pr/pull/204092
  • [x] https://github.com/MicrosoftDocs/azure-docs-pr/pull/204098
  • [x] https://github.com/MicrosoftDocs/azure-docs-pr/pull/204232
  • [x] https://github.com/MicrosoftDocs/azure-docs-pr/pull/204234
  • [x] https://github.com/MicrosoftDocs/azure-docs-pr/pull/204248
  • [x] https://github.com/MicrosoftDocs/azure-docs-pr/pull/204255

chenrujun avatar Jul 07 '22 09:07 chenrujun

Designs:

  • [x] App Configuration. https://github.com/microsoft/spring-cloud-azure/discussions/978
  • [x] Azure AD
  • [x] Cosmos DB
  • [x] Key Vault
  • [x] Service Bus
  • [x] Event Hubs
  • [x] Storage

chenrujun avatar Jul 12 '22 09:07 chenrujun

Update Key Vault: https://github.com/MicrosoftDocs/azure-docs-pr/pull/205476 Update Event Hubs: https://github.com/MicrosoftDocs/azure-docs-pr/pull/205486

Netyyyy avatar Jul 21 '22 07:07 Netyyyy

Update Azure Active Directory: https://github.com/MicrosoftDocs/azure-docs-pr/pull/207687

chenrujun avatar Aug 11 '22 09:08 chenrujun

Update Service Bus: https://github.com/MicrosoftDocs/azure-docs-pr/pull/207807

chenrujun avatar Aug 12 '22 05:08 chenrujun

Update Azure Storage: https://github.com/MicrosoftDocs/azure-docs-pr/pull/207815

chenrujun avatar Aug 12 '22 06:08 chenrujun

All designs are written in One Note.

chenrujun avatar Aug 12 '22 06:08 chenrujun

Closing this issue because all related PRs have been merged.

chenrujun avatar Aug 25 '22 01:08 chenrujun