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

Update README for legacy branch #1858

Open
wants to merge 2 commits into
base: legacy
Choose a base branch
from
Open

Conversation

heaths
Copy link
Member

@heaths heaths commented Oct 16, 2024

No description provided.

@heaths heaths changed the title legacy docs Update README for legacy branch Oct 16, 2024
@heaths heaths changed the base branch from main to legacy October 16, 2024 22:48
@@ -30,7 +30,7 @@ Azure service crates generated from [Azure REST API Specifications](https://gith

## Status

🚨 WARNING 🚨: This project is under active development. Be aware that large breaking changes will happen before 1.0 is reached.
🚨 WARNING 🚨: This project is no longer under active development. Work on officially supported crates is being done in the `main` branch. Pull requests to `legacy` may be considered but are not guaranteed to be merged. Instead, you might consider forking this repository, creating a topic branch you'd need to submit a pull request anyway, and [override dependencies](https://doc.rust-lang.org/cargo/reference/overriding-dependencies.html) in your `Cargo.toml` file(s) as necessary.
Copy link
Member

Choose a reason for hiding this comment

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

I don't like suggesting they fork. I'd rather they migrate to the new crates

Copy link
Member Author

Choose a reason for hiding this comment

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

That text is already above. I'm taking into account - much further below in this file - that they may not be able to, especially before they are ready. We could opt not to suggest something (and I intentionally do not go into too many details), but that may just lead to more issues being opened. If that's the case, we should consider a bot response.

Copy link
Member

Choose a reason for hiding this comment

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

Can we say please migrate to the new crates or open issues/PRs against main. Forking as a last resort .....

// @ronniegeraghty Any opinions on this wording?

Copy link
Member

Choose a reason for hiding this comment

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

That text is already above. I'm taking into account - much further below in this file - that they may not be able to, especially before they are ready. We could opt not to suggest something (and I intentionally do not go into too many details), but that may just lead to more issues being opened. If that's the case, we should consider a bot response.

Makes sense. I'm hoping to get issues so we learn who was using these crates and which ones we might want to prioritize

Copy link
Member

Choose a reason for hiding this comment

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

Maybe adding something like: "These crates should NEVER be used in a production setting."

README.md Outdated Show resolved Hide resolved
Co-authored-by: Ronnie Geraghty  <[email protected]>
@ronniegeraghty
Copy link
Member

Is this the text for the individual track 1 package README.md files? Or is this for the main README.md in the legacy branch?
Just some grammar to fix if it's for the main README.md to reference packages and not a package.

@heaths
Copy link
Member Author

heaths commented Oct 16, 2024

Is this the text for the individual track 1 package README.md files? Or is this for the main README.md in the legacy branch? Just some grammar to fix if it's for the main README.md to reference packages and not a package.

It's the README.md in the root, which you can see in the Files tab.


> Microsoft is developing the official Azure SDK for Rust crates and has no plans to update this unofficial crate.
> Microsoft is developing the official Azure SDK for Rust crates and has no plans to update these unofficial crates.
> In the future we may release an official version that may have a different package name.
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
> In the future we may release an official version that may have a different package name.
> In the future we may release official versions that may have a different package names.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants