Redesign the TOC and landing page of MS docs of Spring Cloud Azure

chenrujun commented 1 year ago

Context

MS docs of Spring Cloud Azure: https://learn.microsoft.com/en-us/azure/developer/java/spring-framework/
Overview of landing pages: https://review.learn.microsoft.com/en-us/help/platform/navigation-landing-page-overview?branch=main

Problem

Current page is confusing.

Customer may be confused about the TOC:
Customer may be confused about the landing page:

Goal

Update current TOC and landing page. Make them more reasonable, make them scenario based. For example:

Getting Started Guides -- Spring Cloud -- Azure Event Hubs
Getting Started Guides -- Messaging -- Messaging with Azure Event Hubs
Getting started guides -- spring boot -- azure storage
Getting started guides -- storage -- uploading files to azure storage blob

stliu commented 1 year ago

Improve Toc / Reference

main tasks

split appendix section
ignore migration for now
correct link

Reference

Current:

Spring Cloud Azure reference
Spring Cloud Azure reference appendix
Spring Framework --> https://spring.io
Learn Spring --> https://spring.io/guides
Spring Boot --> https://spring.io/projects/spring-boot/
Spring Project References --> https://spring.io/projects

Changed:

stliu commented 1 year ago

Improve ToC / Getting started

Getting Started

Overview
- NOTE: the article title should be change to 'Spring Cloud Azure Overview', keep the content as it is for now.
Storage
- Uploading File to Azure Storage Blob
  - NOTE: the article title should also be changed to this one from 'How to use the Spring Boot Starter for Azure Storage'
Security
- Secret Management
  - Load secret from Azure KeyVault Secret
    - NOTE: the article title should be changed to this one from 'Tutorial: Read a secret from Azure Key Vault in a Spring Boot application'
- HTTPS / TLS
  - Enable HTTPS in Spring Boot with Azure KeyVault Certificates
- Authentication and Authorization
  - Secure REST API using Spring Security 5 and Azure Active Directory
    - NOTE: change the article title to this, also change the first paragraph of this article
      - In this tutorial, you learn how to:
        
        Create a Java application using the Spring Initializr
        
        Configure Azure Active Directory
        
        Secure the application with Spring Boot classes and annotations
        
        Build and test your Java application
      - NOTE: no one is expecting to learn how to create a spring application using spring initializr from this doc
      - Just say what is goal of this doc
  - Enable OIDC login in Spring by Azure Active Directory B2C
  - Azure Active Directory Dev Guide
  - Password Less Connection
    - Access Database without password in Spring
    - Migrate to use password less connections
Messaging
- Using JMS in Spring to access Azure Service Bus
  - NOTE: also change article title
- Spring Cloud Stream with Azure Event Hubs
- Spring Cloud Stream with Azure Service Bus
- Using Spring Kafka with Azure Event Hubs for Kafka API
Database
- NoSQL - Azure Cosmos DB
  - Azure Cosmos DB Dev Guide
  - Accessing Data with Azure Cosmos DB NO SQL API
  - Azure Cosmos DB with App Service on Linux
  - Using Spring Data with Azure Cosmos DB for Apache Cassandra API
  - Using Spring Data with Azure Cosmos DB for MongoDB API
  - JDBC
  - JPA
    - NOTE: more the three JPA getting started here
  - R2DBC
    - NOTE: more the three R2DBC getting started here
- Caching
  - Using Azure Redis Cache in Spring
    - NOTE: also change the article title
- Configuration Management
Serverless
- Spring Cloud Function in Azure

stliu commented 1 year ago

task improve toc/samples

remove this section from toc

stliu commented 1 year ago

tasks improve toc/tutorials

Move these from Spring Cloud Azure docs to Spring on Azure Doc, then remove this tutorials from spring cloud azure ms doc toc

Deploy to Azure Spring Apps
Deploy to Kubernetes
Deploy to Azure App Services
End-to-end App Service with MySQL

stliu commented 1 year ago

Okay, now this is the final version, and a clean one (w/o comment or NOTE)

Spring Cloud Azure

Getting Started

Overview
Storage
- Uploading File to Azure Storage Blob
Security
- Secret Management
  - Load secret from Azure KeyVault Secret
- HTTPS / TLS
  - Enable HTTPS in Spring Boot with Azure KeyVault Certificates
- Authentication and Authorization
  - Secure REST API using Spring Security 5 and Azure Active Directory
  - Enable OIDC login in Spring by Azure Active Directory B2C
  - Azure Active Directory Dev Guide
  - Password Less Connection
    - Access Database without password in Spring
    - Migrate to use password less connections
Messaging
Database
- NoSQL - Azure Cosmos DB
  - Azure Cosmos DB Dev Guide
  - Accessing Data with Azure Cosmos DB NO SQL API
  - Azure Cosmos DB with App Service on Linux
  - Using Spring Data with Azure Cosmos DB for Apache Cassandra API
  - Using Spring Data with Azure Cosmos DB for MongoDB API
  - JDBC
  - JPA
    - NOTE: more the three JPA getting started here
  - R2DBC
    - NOTE: more the three R2DBC getting started here
- Caching
  - Using Azure Redis Cache in Spring
- Configuration Management
Serverless
- Spring Cloud Function in Azure

Developer Guide

Reference

chenrujun commented 1 year ago

New design of Spring Cloud Azure landing page:

// Note: The number in () is the page view in 2022-12

Spring Cloud Azure documentation (1326)
- Overview
  - Spring Cloud Azure Overview (1072, it's the PV is old page, new page is WIP)
  - Azure for Spring Developers (22)
- Security
  - Secure REST API Using Spring Security and Azure AD (4455)
  - Spring Security Support (4614)
  - Load a secret from Azure Key Vault (3148)
  - Enable OIDC sign in for Spring with Azure AD B2C (1169)
  - Enable HTTPS in Spring Boot with Azure Key Vault certificates (717)
  - Access a database without passwords in Spring (313)
  - Migrate to use passwordless connections - Azure PostgreSQL (280)
  - Migrate to use passwordless connections = Azure MySQL (124)
  - Migrate to use passwordless connections = Azure SQL Database (123)
- Storage
  - Upload a file to Azure Storage Blob (2772)
- Messaging
  - Using JMS to Access Azure Service Bus (2330)
  - Spring Cloud Stream with Azure Event Hubs (1619)
  - Spring Cloud Stream with Azure Service Bus (1059)
  - Use Spring Kafka with Azure Event Hubs for Kafka API (583)
- Serverless (Not display this one because it's not related to Spring Cloud Azure)
  - Spring Cloud Function in Azure (1253, not display this one because it's not related to Spring Cloud Azure)
- Database
  - Accessing data with Azure Cosmos DB NoSQL API (1214)
  - Azure Cosmos DB Dev Guide (1010. This page will be moved into "Developer Guide")
  - Use Spring Data with Azure Cosmos DB for MongoDB API (269)
  - Use Spring Data with Azure Cosmos DB for Apache Cassandra API (73)
  - JDBC with Azure SQL Server (1074)
  - JDBC with Azure PostgreSQL (494)
  - JDBC with Azure MySQL (258)
  - JPA with Azure SQL Database (627)
  - JPA with Azure MySQL (412)
  - JPA with Azure PostgreSQL (232)
  - R2DBC with Azure PostgreSQL (282)
  - R2DBC with Azure SQL Server (243)
  - R2DBC with Azure MySQL (198)
- Caching
  - Use Azure Redis Cache in Spring (702)
- Configuration Management
  - Externalize configuration properties to Azure App Configuration (760)
  - Use Key Vault references (543)
  - Use feature flags (440)
  - Add feature flags (245)
  - Use dynamic configuration (142)
- Developer Guide (1938, not display this page in new landing page, because we are spliting this page now.)

hui1110 commented 1 year ago

Created PR to update landing page: https://github.com/MicrosoftDocs/azure-dev-docs-pr/pull/4022

chenrujun commented 1 year ago

[x] PR to update landing page: https://github.com/MicrosoftDocs/azure-dev-docs-pr/pull/4022
[x] PR to update the developer guide directory structure: https://github.com/MicrosoftDocs/azure-dev-docs-pr/pull/3994

chenrujun commented 1 year ago

Closing this issue because all related PRs have been merged.

Azure / azure-sdk-for-java