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.03k stars 1.19k forks source link

Consider onboarding packages in the docs.ms ToC to docs.ms #20083

Closed danieljurek closed 2 years ago

danieljurek commented 2 years ago

Following packages are listed in the old docs.ms ToC but not in the package onboarding. That is, no documentation was being built for these packages but if it was these packages would have a place in the ToC.

Packages: 

azure-graph
adal-node
azure-arm-domainservices
azure-arm-advisor
azure-arm-analysisservices
azure-arm-apimanagement
applicationinsights
azure-arm-appinsights
azure-arm-website
azure-asm-website
azure-arm-authorization
azure-arm-automation
azure-batch
azure-arm-batch
azure-arm-batchai
azure-arm-recoveryservicesbackup
azure-arm-billing
azure-arm-cdn
azure-arm-consumption
azure-cognitiveservices-autosuggest
azure-cognitiveservices-customimagesearch
azure-cognitiveservices-visualsearch
azure-cognitiveservices-websearch
azure-cognitiveservices-imagesearch
azure-cognitiveservices-entitysearch
azure-cognitiveservices-customsearch
azure-cognitiveservices-videosearch
azure-cognitiveservices-newssearch
azure-cognitiveservices-spellcheck
azure-cognitiveservices-computervision
azure-cognitiveservices-contentmoderator
azure-cognitiveservices-customvision-training
azure-cognitiveservices-customvision-prediction
azure-cognitiveservices-face
azure-cognitiveservices-luis-authoring
azure-cognitiveservices-luis-runtime
azure-cognitiveservices-textanalytics
microsoft-speech-browser-sdk
azure-arm-cognitiveservices
azure-arm-commerce
azure-arm-containerinstance
azure-arm-containerregistry
azure-arm-containerservice
azure-arm-documentdb
azure-arm-cosmosdb
documentdb
azure-arm-customerinsights
@azure/arm-edgegateway
azure-arm-datafactory
azure-arm-datalake-analytics
azure-arm-datalake-store
azure-arm-devtestlabs
azure-arm-dns
azure-eventgrid
azure-arm-eventgrid
azure-arm-hdinsight
azure-arm-hdinsight-jobs
azure-asm-hdinsight
azure-arm-iothub
azure-iot-digitaltwins-service
azure-iot-device-amqp
azure-iot-device-mqtt
azure-iot-device-http
azure-arm-deviceprovisioningservices
azure-iot-provisioning-device-amqp
azure-iot-provisioning-device-mqtt
azure-iot-provisioning-device-http
azure-arm-keyvault
azure-arm-labservices
azure-loganalytics
azure-arm-operations
azure-arm-logic
azure-arm-machinelearning
azure-arm-machinelearningcompute
azure-maps-drawing-tools
azure-arm-marketplaceordering
azure-arm-mediaservices
azure-ai-metrics-advisor
azure-arm-mobileengagement
azure-arm-insights
azure-arm-monitor
azure-arm-mysql
azure-arm-notificationhubs
azure-arm-operationalinsights
azure-arm-postgresql
azure-arm-powerbiembedded
azure-arm-recoveryservices
azure-arm-rediscache
azure-arm-relay
azure-arm-resource
@azure/arm-resource
azure-arm-resourcehealth
azure-arm-resources-subscriptions
ms-rest
ms-rest-azure
azure-arm-servermanagement
azure-scheduler
azure-arm-scheduler
azure-arm-search
azure-sb
azure-arm-sb
azure-asm-sb
azure-servicefabric
azure-arm-servicefabric
azure-arm-servicemap
azure-arm-recoveryservices-siterecovery
azure-arm-sql
azure-asm-sql
azure-asm-storage
azure-arm-storsimple8000series
azure-arm-streamanalytics
azure-arm-streamanalytics
azure-arm-trafficmanager
azure-asm-trafficmanager
azure-arm-compute
azure-asm-compute
azure-arm-network
azure-asm-network
azure-arm-visualstudio
azure-web-pubsub
azure-web-pubsub-express
kurtzeborn commented 2 years ago

I'm trying to understand what this means. Once you're done automating ToC generation, I thought that meant that when new packages are added/on-boarded, they will automatically appear in the ToC when they release. Is this issue because of track 1 packages maybe outside of our engineering/release system?

danieljurek commented 2 years ago

A quick synchronous perusal of those starting with "@azure" shows some cool stuff:

To add any package in this list to our ToC:

  1. Ensure an entry for this appears in the CSV metadata with a desired location for a ToC
  2. Ensure that there is a package-level overview md file for the package checked into the docs repo
  3. Onboard the package to the appropriate .json in the docs ci-config folder

Automation will build the docs and generate a valid ToC entry.

kurtzeborn commented 2 years ago

Since we have not (and currently don't) generate docs for packages in this list (despite the fact that they're listed in our ToC), I'm fine letting these fall to the wayside until we either on-board them to our engineering system (and our ref docs publishing by extension) or they come to us with some other related ask for docs.