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

Add MSDocs for Azure SDK for C++ and link it to azure.github.io/azure-sdk

Open vhvb1989 opened this issue 4 years ago • 5 comments

There should be a link from https://azure.github.io/azure-sdk/releases/latest/#c to the MSDocs, but the link is not showing up as there are not MSDocs for the Azure SDK for C++.

vhvb1989 avatar Jul 26 '21 18:07 vhvb1989

@vhvb1989 @RickWinter We have a reference listing on docs now (https://docs.microsoft.com/azure/storage/blobs/reference#c-client-libraries), which directs to https://azure.github.io/azure-sdk-for-cpp/index.html for the API reference.

Do you want to link to the docs page, or directly to azure.github.io?

kyle-patterson avatar Aug 05 '21 13:08 kyle-patterson

@vhvb1989 @RickWinter We have a reference listing on docs now (https://docs.microsoft.com/azure/storage/blobs/reference#c-client-libraries), which directs to https://azure.github.io/azure-sdk-for-cpp/index.html for the API reference.

Do you want to link to the docs page, or directly to azure.github.io?

The link in docs is too short IMO. And the docs from github.io is for preview releases AFAIK.

I was hoping if we could have something like the other languages have (see python: https://docs.microsoft.com/en-us/azure/developer/python/?view=azure-python) where there's plenty official docs for the GA versions

vhvb1989 avatar Aug 05 '21 17:08 vhvb1989

The github.io page shows 12.0.1 for storage (and every other release), so I think in terms of API reference it's the best candidate.

As far as the developer page, #1598 is tracking that - it's on the radar, but will need more time. For now, we should focus efforts on getting an API ref back on the releases page...

kyle-patterson avatar Aug 05 '21 18:08 kyle-patterson

@kyle-patterson I have created this PR: https://github.com/Azure/azure-sdk/pull/3290 to use the github docs for the GA releases as a temporal fix.

Once the other mentioned issues are completed, we can update this temporal fix and link GA docs to MSdocs. Let's keep this issue open until that happen

vhvb1989 avatar Aug 25 '21 18:08 vhvb1989

Quick update, the PR was completed and docs links (github.io) are now appearing in the aka.ms/azsdk table. Thank you @vhvb1989 ! I will work with related service owners to address #1598

image

kyle-patterson avatar Sep 01 '21 15:09 kyle-patterson

Hi @vhvb1989, we deeply appreciate your input into this project. Regrettably, this issue has remained inactive for over 2 years, leading us to the decision to close it. We've implemented this policy to maintain the relevance of our issue queue and facilitate easier navigation for new contributors. If you still believe this topic requires attention, please feel free to create a new issue, referencing this one. Thank you for your understanding and ongoing support.

github-actions[bot] avatar Mar 27 '24 18:03 github-actions[bot]