Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove the word experimental in readmes #18773

Merged
1 commit merged into from
Nov 23, 2021

Conversation

ramya-rao-a
Copy link
Contributor

We have the word "Experimental" in the titles in the readme files for our core packages.

My guess is that we started with this when we were working on core v2, forgot to remove it when core v2 went GA and all our newer core packages from them did a copy/paste :)

@xirzec, @joheredi Am I missing something?

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.

Should our customers expect something in particular when they see the experimental word in the docs? does it affect versioning expectation? since I never heard about it before I guess it is meaningless and should be removed but I could be wrong.

@ramya-rao-a
Copy link
Contributor Author

The presence of alpha/beta in the package version should reflect the supportability aspect of things.
The only case I can think of where having experimental listed in the readme is useful is if it is an unpublished package and someone landed on the readme page in the github repo wondering what it is

Copy link
Member

@joheredi joheredi left a comment

Choose a reason for hiding this comment

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

I'm good with the change. I think alpha/beta versions should indicate the experimental nature of libraries. While the ones we already GAd are definitely no longer experimental

@deyaaeldeen
Copy link
Member

deyaaeldeen commented Nov 22, 2021

The only case I can think of where having experimental listed in the readme is useful is if it is an unpublished package and someone landed on the readme page in the github repo wondering what it is

That seems to be a good use. In this case, perhaps leave it in core-crypto?

EDIT: and core-util. Also to be less confusing, should we say unpublished instead?

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.

Looks good, though as Deya mentions, perhaps revert for the packages that haven't GA'd?

@ramya-rao-a
Copy link
Contributor Author

Fair point. Left the term experimental in core-crypto and core-util

@ghost
Copy link

ghost commented Nov 22, 2021

Hello @ramya-rao-a!

Because this pull request has the auto-merge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

@ghost ghost merged commit 8a74b73 into Azure:main Nov 23, 2021
deyaaeldeen pushed a commit to deyaaeldeen/azure-sdk-for-js that referenced this pull request Nov 29, 2021
We have the word "Experimental" in the titles in the readme files for our core packages.

My guess is that we started with this when we were working on core v2, forgot to remove it when core v2 went GA and all our newer core packages from them did a copy/paste :)

@xirzec, @joheredi Am I missing something?
deyaaeldeen added a commit that referenced this pull request Dec 2, 2021
* Check is value is undefined in appendQueryParams (#18621)

* Check is value is undefined in appendQueryParams

* Minor change

* Response to PR comments

* Update sdk/core/core-client/src/urlHelpers.ts

Co-authored-by: Jeff Fisher <xirzec@xirzec.com>

* Minor refactor

Co-authored-by: Jeff Fisher <xirzec@xirzec.com>

* Post release automated changes for core releases (#18358)

Post release automated changes for azure-core-client

* Remove the word experimental in readmes (#18773)

We have the word "Experimental" in the titles in the readme files for our core packages.

My guess is that we started with this when we were working on core v2, forgot to remove it when core v2 went GA and all our newer core packages from them did a copy/paste :)

@xirzec, @joheredi Am I missing something?

* Update Changelog to include query param check (#18851)

* Update Changelog to include query param check

* Update sdk/core/core-client/CHANGELOG.md

Co-authored-by: Deyaaeldeen Almahallawi <dealmaha@microsoft.com>

Co-authored-by: Deyaaeldeen Almahallawi <dealmaha@microsoft.com>

* fix reinstall native dependency (#18582)

* Generate absolute path for symlink to reinstall native dependency

Co-authored-by: Sarangan Rajamanickam <sarajama@microsoft.com>
Co-authored-by: Jeff Fisher <xirzec@xirzec.com>
Co-authored-by: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com>
Co-authored-by: Ramya Rao <ramya.rao.a@outlook.com>
Co-authored-by: praveenkuttappan <55455725+praveenkuttappan@users.noreply.github.com>
deyaaeldeen added a commit that referenced this pull request Dec 2, 2021
…) (#18925)

* Check is value is undefined in appendQueryParams (#18621)

* Check is value is undefined in appendQueryParams

* Minor change

* Response to PR comments

* Update sdk/core/core-client/src/urlHelpers.ts

Co-authored-by: Jeff Fisher <xirzec@xirzec.com>

* Minor refactor

Co-authored-by: Jeff Fisher <xirzec@xirzec.com>

* Post release automated changes for core releases (#18358)

Post release automated changes for azure-core-client

* Remove the word experimental in readmes (#18773)

We have the word "Experimental" in the titles in the readme files for our core packages.

My guess is that we started with this when we were working on core v2, forgot to remove it when core v2 went GA and all our newer core packages from them did a copy/paste :)

@xirzec, @joheredi Am I missing something?

* Update Changelog to include query param check (#18851)

* Update Changelog to include query param check

* Update sdk/core/core-client/CHANGELOG.md

Co-authored-by: Deyaaeldeen Almahallawi <dealmaha@microsoft.com>

Co-authored-by: Deyaaeldeen Almahallawi <dealmaha@microsoft.com>

* fix reinstall native dependency (#18582)

* Generate absolute path for symlink to reinstall native dependency

Co-authored-by: Sarangan Rajamanickam <sarajama@microsoft.com>
Co-authored-by: Jeff Fisher <xirzec@xirzec.com>
Co-authored-by: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com>
Co-authored-by: Ramya Rao <ramya.rao.a@outlook.com>
Co-authored-by: praveenkuttappan <55455725+praveenkuttappan@users.noreply.github.com>

Co-authored-by: Sarangan Rajamanickam <sarajama@microsoft.com>
Co-authored-by: Jeff Fisher <xirzec@xirzec.com>
Co-authored-by: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com>
Co-authored-by: Ramya Rao <ramya.rao.a@outlook.com>
Co-authored-by: praveenkuttappan <55455725+praveenkuttappan@users.noreply.github.com>
azure-sdk pushed a commit to azure-sdk/azure-sdk-for-js that referenced this pull request May 5, 2022
This pull request was closed.
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.

4 participants