Azure / Azure/azure-sdk-tools

Add SDK documentation links to the SDK release apps

Open
#7,972 0 comments 0 reactions 1 assignee Claimed by @jrferry101 View on GitHub
Client Engagement Experience
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
144

Description

As an example, for management plane app, there is a step called `Verify the Release` in that step one of the checks is to verify `Publish SDK reference docs`. It currently includes a link to the publish docs documentation and it suggest people to look a tthe preview docs. But at this point, we want people to look at the live docs and when they attest everything looks good, then they can complete it.
A way to verify this could be to add a link to https://azure.github.io/azure-sdk/releases/latest/ and ask the user to look for their package and look at the doc generated there.

As an example, for `sphere`, the informaton is: https://azure.github.io/azure-sdk/releases/latest/?search=sphere

Look into what should be the case for Data Plane libraries

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.