Doc settings Update (#14733)
This commit is contained in:
KarishmaGhiya
GitHub
Родитель
72f82fa4b2
Коммит
4f6c5f7d03
|
|
@ -25,6 +25,7 @@ omitted_paths:
|
|||
- sdk/eventhub/event-hubs/test/perf/track-2/*
|
||||
- sdk/schemaregistry/README.md
|
||||
- sdk/storage/*/test/README.md
|
||||
- sdk/storage/README.md
|
||||
- sdk/storage/storage-internal-avro/*
|
||||
- sdk/storage/*/test/perfstress/track-1/*
|
||||
- sdk/storage/*/test/perfstress/track-2/*
|
||||
|
|
@ -45,19 +46,6 @@ required_readme_sections:
|
|||
- ^Next steps$
|
||||
- ^Contributing$
|
||||
|
||||
known_presence_issues:
|
||||
- ["CHANGELOG.md", "#1583"]
|
||||
- ["sdk/applicationinsights/applicationinsights-query/CHANGELOG.md", "#1583"]
|
||||
- ["sdk/batch/batch/CHANGELOG.md", "#1583"]
|
||||
- ["sdk/eventgrid/eventgrid/CHANGELOG.md", "#1583"]
|
||||
- ["sdk/graphrbac/graph/CHANGELOG.md", "#1583"]
|
||||
- ["sdk/operationalinsights/loganalytics/CHANGELOG.md", "#1583"]
|
||||
- ["sdk/servicefabric/servicefabric/CHANGELOG.md", "#1583"]
|
||||
- ["sdk/storage/storage-datalake/CHANGELOG.md", "#1583"]
|
||||
- ["sdk/template/template/CHANGELOG.md", "#1583"]
|
||||
- ["sdk/test-utils/recorder/CHANGELOG.md", "#1583"]
|
||||
- ["sdk/test-utils/perfstress/CHANGELOG.md", "#1583"]
|
||||
|
||||
known_content_issues:
|
||||
- ["README.md", "#1583"]
|
||||
- ["sdk/appconfiguration/app-configuration/README.md", "#1583"]
|
||||
|
|
@ -67,77 +55,65 @@ known_content_issues:
|
|||
"sdk/cognitiveservices/cognitiveservices-anomalydetector/README.md",
|
||||
"#1583",
|
||||
]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-autosuggest/README.md", "#1583"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-autosuggest/README.md", "#Azure/autorest.typescript#895"]
|
||||
- [
|
||||
"sdk/cognitiveservices/cognitiveservices-computervision/README.md",
|
||||
"#1583",
|
||||
"#Azure/autorest.typescript#895",
|
||||
]
|
||||
- [
|
||||
"sdk/cognitiveservices/cognitiveservices-contentmoderator/README.md",
|
||||
"#1583",
|
||||
"#Azure/autorest.typescript#895",
|
||||
]
|
||||
- [
|
||||
"sdk/cognitiveservices/cognitiveservices-customimagesearch/README.md",
|
||||
"#1583",
|
||||
"#Azure/autorest.typescript#895",
|
||||
]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-customsearch/README.md", "#1583"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-customsearch/README.md", "#Azure/autorest.typescript#895"]
|
||||
- [
|
||||
"sdk/cognitiveservices/cognitiveservices-customvision-prediction/README.md",
|
||||
"#1583",
|
||||
"#Azure/autorest.typescript#895",
|
||||
]
|
||||
- [
|
||||
"sdk/cognitiveservices/cognitiveservices-customvision-training/README.md",
|
||||
"#1583",
|
||||
"#Azure/autorest.typescript#895",
|
||||
]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-entitysearch/README.md", "#1583"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-face/README.md", "#1583"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-imagesearch/README.md", "#1583"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-localsearch/README.md", "#1583"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-entitysearch/README.md", "#Azure/autorest.typescript#895"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-face/README.md", "#Azure/autorest.typescript#895"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-imagesearch/README.md", "#Azure/autorest.typescript#895"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-localsearch/README.md", "#Azure/autorest.typescript#895"]
|
||||
- [
|
||||
"sdk/cognitiveservices/cognitiveservices-luis-authoring/README.md",
|
||||
"#1583",
|
||||
"#Azure/autorest.typescript#895",
|
||||
]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-luis-runtime/README.md", "#1583"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-newssearch/README.md", "#1583"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-qnamaker/README.md", "#1583"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-spellcheck/README.md", "#1583"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-luis-runtime/README.md", "#Azure/autorest.typescript#895"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-newssearch/README.md", "#Azure/autorest.typescript#895"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-qnamaker/README.md", "#Azure/autorest.typescript#895"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-spellcheck/README.md", "#Azure/autorest.typescript#895"]
|
||||
- [
|
||||
"sdk/cognitiveservices/cognitiveservices-textanalytics/README.md",
|
||||
"#1583",
|
||||
"#Azure/autorest.typescript#895",
|
||||
]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-videosearch/README.md", "#1583"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-visualsearch/README.md", "#1583"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-websearch/README.md", "#1583"]
|
||||
- ["sdk/core/abort-controller/README.md", "#1583"]
|
||||
- ["sdk/core/core-amqp/README.md", "#1583"]
|
||||
- ["sdk/core/core-auth/README.md", "#1583"]
|
||||
- ["sdk/core/core-tracing/README.md", "#1583"]
|
||||
- ["sdk/core/logger/README.md", "#1583"]
|
||||
- ["sdk/cosmosdb/cosmos/README.md", "#1583"]
|
||||
- ["sdk/cosmosdb/cosmos/test/readme.md", "#1583"]
|
||||
- ["sdk/eventgrid/eventgrid/README.md", "#1583"]
|
||||
- ["sdk/eventhub/event-hubs/README.md", "#1583"]
|
||||
- ["sdk/eventhub/eventhubs-checkpointstore-blob/README.md", "#1583"]
|
||||
- ["sdk/eventhub/event-processor-host/README.md", "#1583"]
|
||||
- ["sdk/eventhub/README.md", "#1583"]
|
||||
- ["sdk/eventhub/mock-hub/README.md", "#1583"]
|
||||
- ["sdk/graphrbac/graph/README.md", "#1583"]
|
||||
- ["sdk/keyvault/README.md", "#1583"]
|
||||
- ["sdk/operationalinsights/loganalytics/README.md", "#1583"]
|
||||
- ["sdk/servicebus/service-bus/README.md", "#1583"]
|
||||
- ["sdk/servicebus/service-bus/test/README.md", "#1583"]
|
||||
- ["sdk/servicefabric/servicefabric/README.md", "#1583"]
|
||||
- ["sdk/storage/README.md", "#1583"]
|
||||
- ["sdk/storage/storage-blob/test/README.md", "#1583"]
|
||||
- ["sdk/storage/storage-datalake/README.md", "#1583"]
|
||||
- ["sdk/storage/storage-file-datalake/test/README.md", "#1583"]
|
||||
- ["sdk/storage/storage-file-share/test/README.md", "#1583"]
|
||||
- ["sdk/storage/storage-queue/test/README.md", "#1583"]
|
||||
- ["sdk/synapse/synapse/README.md", "#1583"]
|
||||
- ["sdk/template/template/README.md", "#1583"]
|
||||
- ["sdk/test-utils/recorder/README.md", "#1583"]
|
||||
- ["sdk/test-utils/multi-version/README.md", "#1583"]
|
||||
- ["sdk/test-utils/perfstress/CHANGELOG.md", "#1583"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-videosearch/README.md", "#Azure/autorest.typescript#895"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-visualsearch/README.md", "#Azure/autorest.typescript#895"]
|
||||
- ["sdk/cognitiveservices/cognitiveservices-websearch/README.md", "#Azure/autorest.typescript#895"]
|
||||
- ["sdk/core/abort-controller/README.md", "#14714"]
|
||||
- ["sdk/core/core-amqp/README.md", "#14715"]
|
||||
- ["sdk/core/core-auth/README.md", "#14716"]
|
||||
- ["sdk/core/core-tracing/README.md", "#14725"]
|
||||
- ["sdk/core/logger/README.md", "#14726"]
|
||||
- ["sdk/cosmosdb/cosmos/test/readme.md", "azure-sdk-tools/issues/1530"]
|
||||
- ["sdk/eventhub/event-processor-host/README.md", "#14727"]
|
||||
- ["sdk/eventhub/mock-hub/README.md", "azure-sdk-tools/issues/1530"]
|
||||
- ["sdk/graphrbac/graph/README.md", "#deprecated"]
|
||||
- ["sdk/operationalinsights/loganalytics/README.md", "#14729"]
|
||||
- ["sdk/servicebus/service-bus/test/README.md", "azure-sdk-tools/issues/1530"]
|
||||
- ["sdk/servicefabric/servicefabric/README.md", "#14732"]
|
||||
- ["sdk/storage/storage-datalake/README.md", "#14731"]
|
||||
- ["sdk/storage/storage-blob/test/README.md", "azure-sdk-tools/issues/1530"]
|
||||
- ["sdk/storage/storage-file-datalake/test/README.md", "azure-sdk-tools/issues/1530"]
|
||||
- ["sdk/storage/storage-file-share/test/README.md", "azure-sdk-tools/issues/1530"]
|
||||
- ["sdk/storage/storage-queue/test/README.md", "azure-sdk-tools/issues/1530"]
|
||||
- ["sdk/test-utils/multi-version/README.md", "#14728"]
|
||||
|
||||
package_indexing_exclusion_list:
|
||||
- "@azure/template"
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Azure Event Hubs client library for Javascript
|
||||
# Azure Event Hubs client library for JavaScript
|
||||
|
||||
Azure Event Hubs is a highly scalable publish-subscribe service that can ingest millions of events per second and stream them to multiple consumers. This lets you process and analyze the massive amounts of data produced by your connected devices and applications. If you would like to know more about Azure Event Hubs, you may wish to review: [What is Event Hubs](https://docs.microsoft.com/azure/event-hubs/event-hubs-about)?
|
||||
|
||||
|
|
@ -19,7 +19,7 @@ Samples for v2 and documentation are still available here:
|
|||
[Package for v2.1.0 (npm)](https://www.npmjs.com/package/@azure/event-hubs/v/2.1.0) |
|
||||
[Samples for v2.1.0](https://github.com/Azure/azure-sdk-for-js/tree/%40azure/event-hubs_2.1.0/sdk/eventhub/event-hubs/samples)
|
||||
|
||||
## Getting Started
|
||||
## Getting started
|
||||
|
||||
### Install the package
|
||||
|
||||
|
|
@ -263,10 +263,10 @@ async function main() {
|
|||
|
||||
const subscription = client.subscribe(
|
||||
{
|
||||
processEvents: async(events, context) => {
|
||||
processEvents: async (events, context) => {
|
||||
// event processing code goes here
|
||||
},
|
||||
processError: async(err, context) => {
|
||||
processError: async (err, context) => {
|
||||
// error reporting/handling code here
|
||||
}
|
||||
},
|
||||
|
|
@ -394,10 +394,10 @@ async function main() {
|
|||
const subscription = client.subscribe(
|
||||
partitionIds[0],
|
||||
{
|
||||
processEvents: async(events, context) => {
|
||||
processEvents: async (events, context) => {
|
||||
// event processing code goes here
|
||||
},
|
||||
processError: async(err, context) => {
|
||||
processError: async (err, context) => {
|
||||
// error reporting/handling code here
|
||||
}
|
||||
},
|
||||
|
|
@ -492,7 +492,7 @@ export DEBUG=azure*,rhea*,-rhea:raw,-rhea:message
|
|||
export DEBUG=azure:*:(error|warning),rhea-promise:error,rhea:events,rhea:frames,rhea:io,rhea:flow
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
## Next steps
|
||||
|
||||
### More sample code
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Azure Event Hubs Checkpoint Store library for Javascript using Storage Blobs
|
||||
# Azure Event Hubs Checkpoint Store client library for JavaScript
|
||||
|
||||
An Azure Blob storage based solution to store checkpoints and to aid in load balancing when using `EventHubConsumerClient` from the [@azure/event-hubs](https://www.npmjs.com/package/@azure/event-hubs) library
|
||||
|
||||
|
|
@ -193,7 +193,7 @@ export DEBUG=azure:eventhubs-checkpointstore-blob:info
|
|||
node your-test-script.js &> out.log
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
## Next steps
|
||||
|
||||
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventhub/eventhubs-checkpointstore-blob/samples)
|
||||
directory for detailed example.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Azure Service Bus client library for Javascript
|
||||
# Azure Service Bus client library for JavaScript
|
||||
|
||||
[Azure Service Bus](https://azure.microsoft.com/services/service-bus/) is a highly-reliable cloud messaging service from Microsoft.
|
||||
|
||||
|
|
@ -19,7 +19,7 @@ Resources for `@azure/service-bus` version 7:
|
|||
**NOTE**: If you are using version 1.1.10 or lower and want to migrate to the latest version
|
||||
of this package please look at our [migration guide to move from Service Bus V1 to Service Bus V7][migrationguide]
|
||||
|
||||
## Getting Started
|
||||
## Getting started
|
||||
|
||||
### Install the package
|
||||
|
||||
|
|
@ -91,7 +91,7 @@ const serviceBusClient = new ServiceBusClient(fullyQualifiedNamespace, credentia
|
|||
|
||||
More information about this constructor is available in the [API documentation][sbclient_tokencred_overload]
|
||||
|
||||
### Key concepts
|
||||
## Key concepts
|
||||
|
||||
Once you've initialized a `ServiceBusClient`, you can interact with these resources within a
|
||||
Service Bus Namespace:
|
||||
|
|
@ -110,7 +110,7 @@ To interact with these resources, one should be familiar with the following SDK
|
|||
|
||||
Please note that the Queues, Topics and Subscriptions should be created prior to using this library.
|
||||
|
||||
### Examples
|
||||
## Examples
|
||||
|
||||
The following sections provide code snippets that cover some of the common tasks using Azure Service Bus
|
||||
|
||||
|
|
@ -412,7 +412,7 @@ export DEBUG=azure:service-bus:error,azure:core-amqp:error,rhea-promise:error,rh
|
|||
node your-test-script.js &> out.log
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
## Next steps
|
||||
|
||||
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/servicebus/service-bus/samples)
|
||||
directory for detailed examples on how to use this library to send and receive messages to/from
|
||||
|
|
|
|||
|
|
@ -10,20 +10,7 @@ devDependency and should be used only for the tests of an SDK library.
|
|||
|
||||
The idea employed in this library is inspired by [mocha-tags](https://www.npmjs.com/package/mocha-tags).
|
||||
|
||||
## Key concepts
|
||||
|
||||
- Our guideline recommends that service client supporting multiple service API version takes an API
|
||||
version via the `serviceVersion` property of its constructor options bag `*ClientOptions`.
|
||||
- Service API versions supported by the SDK library under test is specified for a top-level Mocha
|
||||
`describe()` test suite. We loop through them and run the test suite on each version.
|
||||
- Testing of multi-service-version support is only done in `live` test mode. For other test modes
|
||||
(`record`, `soft-record`, and `playback`), tests are only running for the latest version, or a
|
||||
chosen version specified via options in case the latest version is not the latest stable version.
|
||||
- Optionally a list or range of versions can be specified for a nested `describe()` test suite or
|
||||
`it()` test case. If the version being tested is not in the range of versions supported by this
|
||||
test suite/case, then the test suite/case is skipped.
|
||||
|
||||
## Get started
|
||||
## Getting started
|
||||
|
||||
We're about to go through how to set up your project to use the `@azure/test-utils-multi-version`
|
||||
package.
|
||||
|
|
@ -91,6 +78,19 @@ rush update
|
|||
|
||||
And you're ready to test your library for multiple service API versions!
|
||||
|
||||
## Key concepts
|
||||
|
||||
- Our guideline recommends that service client supporting multiple service API version takes an API
|
||||
version via the `serviceVersion` property of its constructor options bag `*ClientOptions`.
|
||||
- Service API versions supported by the SDK library under test is specified for a top-level Mocha
|
||||
`describe()` test suite. We loop through them and run the test suite on each version.
|
||||
- Testing of multi-service-version support is only done in `live` test mode. For other test modes
|
||||
(`record`, `soft-record`, and `playback`), tests are only running for the latest version, or a
|
||||
chosen version specified via options in case the latest version is not the latest stable version.
|
||||
- Optionally a list or range of versions can be specified for a nested `describe()` test suite or
|
||||
`it()` test case. If the version being tested is not in the range of versions supported by this
|
||||
test suite/case, then the test suite/case is skipped.
|
||||
|
||||
## Examples
|
||||
|
||||
### Import functions
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
## Azure SDK for JavaScript's test-utils-recorder
|
||||
## Azure test-utils-recorder SDK client library for JavaScript
|
||||
|
||||
The Azure SDK for JavaScript is composed of a multitude of repositories that
|
||||
attempt to deliver a common, homogenous SDK to make use of all of the services
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче