search

Azure / azure-sdk-for-js

This repository is for active development of the Azure SDK for JavaScript (NodeJS & Browser). For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/javascript/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-js.
MIT License
2.09k stars 1.2k forks source link

Title should be "Azure ML Web Services SDK for JavaScript - latest" #26321

Open memildin opened 1 year ago

memildin commented 1 year ago

There is no "Azure Web Services": it's Azure ML Web Services and when you click through to the APIs, you'll see the correct service name is used throughout.

Document Details

⚠ Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.

qiaozha commented 1 year ago

@xirzec I found the generated management plane readme.md title is correct azure-ml-web-services-management-client-library-for-javascript. And it has also been reflected in the docs-ref-services/latest/arm-webservices-readme.md. However, I see each service has this three files

image

Are those files auto generated by the docs publishing process? or should I just manual update the content? I see no content related in this csv https://github.com/Azure/azure-sdk/blob/main/_data/releases/latest/js-packages.csv#L306 that @ckairen has shared before. I hope it will not get override after I edit it.

xirzec commented 1 year ago

@qiaozha I'm happy to approve if you want to try editing, but I defer to @ckairen about how the generation works here.

xirzec commented 1 year ago

@timovv do you know how the magic CSVs work in this case?

timovv commented 1 year ago

I'm not sure what's going on with this page. It looks like it's been orphaned: it doesn't show up in the sidebar or the index when navigating from https://learn.microsoft.com/en-us/javascript/api/overview/azure/?view=azure-node-latest. Looks like it's been replaced by something more aptly named: https://learn.microsoft.com/en-us/javascript/api/overview/azure/machine-learning?view=azure-node-latest

My guess is that the name has been fixed and this file hasn't been cleaned up properly by the automation, and it's probably safe to open a PR to delete that file.

For what it's worth, we do have @azure/arm-webservices in the CSVs, which has a display name "Resource Management - Web Services". Maybe this should also be changed to "Resource Management - ML Web Services"?

memildin commented 1 year ago

@timovv / @xirzec / @qiaozha Any updates?