Skip to content

Commit

Permalink
[core] Fix missing readme headers (Azure#15734)
Browse files Browse the repository at this point in the history
  • Loading branch information
chradek authored Jun 15, 2021
1 parent 0d15c79 commit 9f65a24
Show file tree
Hide file tree
Showing 5 changed files with 96 additions and 11 deletions.
4 changes: 0 additions & 4 deletions eng/.docsettings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,7 @@ required_readme_sections:
- ^Contributing$

known_content_issues:
- ["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/eventhub/event-processor-host/README.md",  "#14727"]
- ["sdk/eventhub/mock-hub/README.md",  "azure-sdk-tools/issues/1530"]
- ["sdk/test-utils/multi-version/README.md", "#14728"]
Expand Down
10 changes: 9 additions & 1 deletion sdk/core/abort-controller/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Azure Abort Controller library for JavaScript
# Azure Abort Controller client library for JavaScript

The `@azure/abort-controller` package provides `AbortController` and `AbortSignal` classes. These classes are compatible
with the [AbortController](https://developer.mozilla.org/docs/Web/API/AbortController) built into modern browsers
Expand Down Expand Up @@ -89,6 +89,14 @@ allTasksController.abort(); // aborts allTasksSignal, subTask
subTask.abort(); // aborts only subTask
```

## Next steps

You can build and run the tests locally by executing `rushx test`. Explore the `test` folder to see advanced usage and behavior of the public classes.

## Troubleshooting

If you run into issues while using this library, please feel free to [file an issue](https://github.com/Azure/azure-sdk-for-js/issues/new).

## Contributing

If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
Expand Down
10 changes: 7 additions & 3 deletions sdk/core/core-amqp/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Azure Core AMQP client library for AMQP operations
# Azure Core AMQP client library for JavaScript

Azure Core AMQP is a library that provides common functionality for **Azure** Javascript
libraries that use [AMQP protocol](https://docs.microsoft.com/azure/service-bus-messaging/service-bus-amqp-protocol-guide)
The `@azure/core-amqp` package provides common functionality for **Azure** JavaScript
libraries that use the [AMQP protocol](https://docs.microsoft.com/azure/service-bus-messaging/service-bus-amqp-protocol-guide)
like the ones for Azure Service Bus and Azure Event Hubs.

## Getting started
Expand All @@ -27,6 +27,10 @@ Some of the key features of Azure Core AMQP library are:
- Error translation of AMQP error codes along with errors specific to Azure Service Bus and Azure Event Hubs.
- RetryPolicy for retrying a given operation if a retryable error was encountered.

## Next steps

You can build and run the tests locally by executing `rushx test`. Explore the `test` folder to see advanced usage and behavior of the public classes.

## Troubleshooting

The core-amqp library depends on the [rhea-promise](https://github.com/amqp/rhea-promise) library for managing connections, and for sending and receiving events over the [AMQP](https://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-complete-v1.0-os.pdf) protocol.
Expand Down
73 changes: 71 additions & 2 deletions sdk/core/core-auth/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,75 @@
## Azure Core Authentication
# Azure Core Authentication client library for JavaScript

This library provides core interfaces and helper methods for authenticating with Azure services using Azure Active Directory and other authentication schemes common across the Azure SDK. As a "core" library, it shouldn't need to be added as a dependency to any user code, only other Azure SDK libraries.
The `@azure/core-auth` package provides core interfaces and helper methods for authenticating with Azure services using Azure Active Directory and other authentication schemes common across the Azure SDK. As a "core" library, it shouldn't need to be added as a dependency to any user code, only other Azure SDK libraries.

## Getting started

### Installation

Install this library using npm as follows

```
npm install @azure/core-auth
```

## Key Concepts

The `TokenCredential` interface represents a credential capable of providing an authentication token. The `@azure/identity` package contains various credentials that implement the `TokenCredential` interface.

The `AzureKeyCredential` is a static key-based credential that supports key rotation via the `update` method. Use this when a single secret value is needed for authentication, e.g. when using a shared access key.

The `AzureNamedKeyCredential` is a static name/key-based credential that supports name and key rotation via the `update` method. Use this when both a secret value and a label are needed, e.g. when using a shared access key and shared access key name.

The `AzureSASCredential` is a static signature-based credential that supports updating the signature value via the `update` method. Use this when using a shared access signature.

## Examples

### AzureKeyCredential

```js
const { AzureKeyCredential } = require("@azure/core-auth");

const credential = new AzureKeyCredential("secret value");
// prints: "secret value"
console.log(credential.key);
credential.update("other secret value");
// prints: "other secret value"
console.log(credential.key);
```

### AzureNamedKeyCredential

```js
const { AzureNamedKeyCredential } = require("@azure/core-auth");

const credential = new AzureNamedKeyCredential("ManagedPolicy", "secret value");
// prints: "ManagedPolicy, secret value"
console.log(`${credential.name}, ${credential.key}`);
credential.update("OtherManagedPolicy", "other secret value");
// prints: "OtherManagedPolicy, other secret value"
console.log(`${credential.name}, ${credential.key}`);
```

### AzureSASCredential

```js
const { AzureSASCredential } = require("@azure/core-auth");

const credential = new AzureSASCredential("signature1");
// prints: "signature1"
console.log(credential.signature);
credential.update("signature2");
// prints: "signature2"
console.log(credential.signature);
```

## Next steps

You can build and run the tests locally by executing `rushx test`. Explore the `test` folder to see advanced usage and behavior of the public classes.

## Troubleshooting

If you run into issues while using this library, please feel free to [file an issue](https://github.com/Azure/azure-sdk-for-js/issues/new).

## Contributing

Expand Down
10 changes: 9 additions & 1 deletion sdk/core/logger/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Azure Logger library for JavaScript
# Azure Logger client library for JavaScript

The `@azure/logger` package can be used to enable logging in the Azure SDKs for JavaScript.

Expand Down Expand Up @@ -73,6 +73,14 @@ Using `AzureLogger`, it is possible to redirect the logging output from the Azur
overriding the `AzureLogger.log` method. This may be useful if you want to redirect logs to
a location other than stderr.

## Next steps

You can build and run the tests locally by executing `rushx test`. Explore the `test` folder to see advanced usage and behavior of the public classes.

## Troubleshooting

If you run into issues while using this library, please feel free to [file an issue](https://github.com/Azure/azure-sdk-for-js/issues/new).

## Contributing

If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
Expand Down

0 comments on commit 9f65a24

Please sign in to comment.