Skip to content

Update cpp-packages.csv with latest documentation links for Azure SDK…#9555

Open
ronniegeraghty wants to merge 1 commit intomainfrom
ronniegeraghty/cpp-docs-updates
Open

Update cpp-packages.csv with latest documentation links for Azure SDK…#9555
ronniegeraghty wants to merge 1 commit intomainfrom
ronniegeraghty/cpp-docs-updates

Conversation

@ronniegeraghty
Copy link
Member

@ronniegeraghty ronniegeraghty commented Jan 21, 2026

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request updates the documentation links for Azure SDK C++ packages in the package index CSV file by replacing "NA" values with actual Microsoft Learn documentation URLs.

Changes:

  • Updated MSDocs column for 17 Azure C++ packages with proper documentation URLs
  • Changed GHDocs column value from "NA" to "NA" for the azure-data-tables package (correcting an inconsistency)

@weshaggard
Copy link
Member

We should try using the url templates so we don't need to maintain these manually https://github.com/Azure/azure-sdk/blob/main/_includes/releases/variables/cpp.md?plain=1#L5

@weshaggard
Copy link
Member

weshaggard commented Jan 21, 2026

You can follow the js example https://github.com/Azure/azure-sdk/blob/main/_includes/releases/variables/js.md?plain=1 as I think you will need the package_trim and the pre_suffix

"azure-data-tables","","1.0.0-beta.6","Tables","Tables","tables","NA","NA","client","true","","","","01/16/2024","","","","","","","",""
"azure-core-tracing-opentelemetry","","1.0.0-beta.4","Tracing","Other","core","NA","","client","true","","","","06/08/2022","","","","","","","",""
"azure-storage-common","12.12.0","","Storage - Common","Storage","storage","NA","","compat","true","","01/08/2026","06/08/2021","08/28/2020","","","","","","","",""
"azure-core-amqp","","1.0.0-beta.11","AMQP","Other","core","https://learn.microsoft.com/cpp/api/overview/azure/core-amqp-readme?view=azure-cpp-preview","","client","true","","","","07/06/2023","","","","","","","",""
Copy link
Member

@antkmsft antkmsft Jan 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it ok that this link has azure-cpp-preview? Or would it get updated to include -preview and back each time we release a GA version or a Beta?

Also, in version numbering, we typically don't use "preview", we use "beta", so that there is no confusion with the service preview versions.

FWIW, I just tested that you could supply azure-cpp, and it still works.
I even dropped the ?view=... all together, and it still works.

BTW, can we drop the -readme from the name, so that the link looks more neat? I.e. https://learn.microsoft.com/cpp/api/overview/azure/core-amqp ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants