Skip to content

Conversation

@ramya-rao-a
Copy link
Contributor

@ramya-rao-a ramya-rao-a commented Jun 25, 2021

As part of #7022, we need to update the README of all our packages to ensure our support policy is up to date.
Net changes in this PR:

  • Instead of replacing Node.js 8 with another number, we link to LTS versions of Node, add list of browsers we support and a link to the support policy.
  • a similar cleanup in the readme files for samples.
  • tweaks to standardize the format around supported environments and prerequesites
  • formatting of the readme files

This PR intentionally focuses only on the readme file.
There will be a separate PR updating the engines field and the version of @types/node in the package.json files.

Ask on package owners: Speak up if your readme file in this PR states browser support but your package does not really work in the browser or the other way around

@ghost ghost added Azure.Identity KeyVault Storage Storage Service (Queues, Blobs, Files) Synapse EngSys This issue is impacting the engineering system. Cognitive - Text Analytics Cognitive - Form Recognizer Cognitive - Metrics Advisor Search Monitor Monitor, Monitor Ingestion, Monitor Query labels Jun 25, 2021
Copy link
Member

@xirzec xirzec left a comment

Choose a reason for hiding this comment

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

Awesome! 🚀

Copy link
Member

@deyaaeldeen deyaaeldeen left a comment

Choose a reason for hiding this comment

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

Thanks a lot!

Copy link
Member

@jeremymeng jeremymeng left a comment

Choose a reason for hiding this comment

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

couple of nits

## Prerequisites

The sample is compatible with Node.js >= 8.0.0
The sample is compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/)
Copy link
Member

Choose a reason for hiding this comment

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

nit: missing period

Suggested change
The sample is compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/)
The sample is compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/).

## Prerequisites

The samples are compatible with Node.js >= 8.0.0.
The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/)
Copy link
Member

Choose a reason for hiding this comment

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

nit: missing period

Suggested change
The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/)
The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/).

### Prerequisites

- An [Azure subscription](https://azure.microsoft.com/free/)
- A[Key Vault resource](https://docs.microsoft.com/azure/key-vault/quick-create-portal)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- A[Key Vault resource](https://docs.microsoft.com/azure/key-vault/quick-create-portal)
- A [Key Vault resource](https://docs.microsoft.com/azure/key-vault/quick-create-portal)

@ramya-rao-a
Copy link
Contributor Author

ramya-rao-a commented Jun 25, 2021

Thanks @jeremymeng, I'll add the missing periods and spaces in a separate PR
Moving ahead with this PR to avoid spam to the very large list of reviewers :)

CI for all is green except cosmos which is a known issue and @zfoster is on it

@ramya-rao-a
Copy link
Contributor Author

/check-enforcer override

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants