azure-sdk-for-java
azure-sdk-for-java copied to clipboard
[Epic] Prepare and publish credential-free docs
This is an epic to track all the doc related tasks of Credential-free connections.
Context
With all the changes we made to support credential-free connections:
- https://github.com/Azure/azure-sdk-for-java/issues/29218
- https://github.com/Azure/azure-sdk-for-java/issues/29785
- https://github.com/Azure/azure-sdk-for-java/issues/28685
we also need to publish/modify docs to help users work with them. The docs include quickstarts, migration guides, and reference docs.
There's a template worked out by Alex can be found here:
- https://github.com/MicrosoftDocs/azure-docs-pr/pull/203348#issuecomment-1205727432
- https://github.com/MicrosoftDocs/azure-docs-pr/pull/203348#issuecomment-1203381358
Service | Java - quickstart | Spring - quickstart | Migration guide |
---|---|---|---|
MySQL | Update existing Java quickstart MySQL | Update existing Spring quickstart MySQL JDBC Update existing Spring quickstart MySQL JPA |
Add new doc (add contextual tabs for Java/Spring) |
PostgreSQL | Update existing Java quickstart PostgreSQL | Update existing Spring quickstart MySQL JDBC Update existing Spring quickstart MySQL JDBC |
Add new doc (add contextual tabs for Java/Spring) |
EventHubs - Kafka | Add new doc | Update existing Spring quickstart Kafka | Add new doc (add contextual tabs for Java/Spring) |
SQL Database | Update existing Java quickstart SQL Database | Update existing Spring quickstart SQL Database JDBC Update existing Spring quickstart SQL Database JPA |
Add new doc (add contextual tabs for Java/Spring) |
Goal
Publish migration documentation after the feature is enabled.
Migration guides
- [ ] https://github.com/Azure/azure-sdk-for-java/issues/29224
- [ ] https://github.com/Azure/azure-sdk-for-java/issues/29782
- [ ] https://github.com/Azure/azure-sdk-for-java/issues/30339
- [ ] https://github.com/Azure/azure-sdk-for-java/issues/30350
Quickstarts
Docs maintained by our team
- [ ] #30437
- [ ] https://github.com/Azure/azure-sdk-for-java/issues/30340
- [ ] https://github.com/Azure/azure-sdk-for-java/issues/29783
- [ ] https://github.com/Azure/azure-sdk-for-java/issues/30341
- [ ] https://github.com/Azure/azure-sdk-for-java/issues/30342
- [ ] https://github.com/Azure/azure-sdk-for-java/issues/30343
- [ ] https://github.com/Azure/azure-sdk-for-java/issues/30345
- [ ] https://github.com/Azure/azure-sdk-for-java/issues/30348
Docs maintained by partner team
- [ ] https://github.com/Azure/azure-sdk-for-java/issues/30346
- [ ] https://github.com/Azure/azure-sdk-for-java/issues/30347
Reference docs
Scattered docs using Spring and MySQL
- [ ] https://github.com/Azure/azure-sdk-for-java/issues/30437