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

Simplify language in the Release Channel section of Get Dart #4414

Closed
atsansone opened this issue Dec 5, 2022 · 0 comments · Fixed by #5497
Closed

Simplify language in the Release Channel section of Get Dart #4414

atsansone opened this issue Dec 5, 2022 · 0 comments · Fixed by #5497
Assignees
Labels
a.get-started Relates to Getting Started with Dart e1-hours Can complete in < 8 hours of normal, not dedicated, work fix.refactor Needs near total rewrite or reorganization of content p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. st.triage.ltw Indicates Lead Tech Writer has triaged

Comments

@atsansone
Copy link
Contributor

Page URL

https://dart.dev/get-dart#release-channels

Page source

src/get-dart/index.md

Describe the problem

The information within the About release channels and version strings section could use better organization. Recommend revising the content to better chunk the information into related blocks.

Expected fix

Recommend using the following copy.

### Stable channel
Dart deploys a release to the _stable_ channel about every three months.
The current stable version is  `[calculating]`{:.build-rev-stable}.

Use stable channel releases for production environments.

Versioning for releases in stable channel of the Dart SDK follows a `x.y.z` format.
The version strings resemble `1.24.3` and `2.1.0`.
This format consists of three dot-separated integers without hyphens or letters.
The versions include the major version (`x`), 
then the minor version (`y`), and then the patch version (`z`).

### Beta channel
Dart releases a build to the _preview_ channel about every month.
The current beta version is  `[calculating]`{:.build-rev-beta}.

These beta channel releases preview features intended for the stable channel.
Use releases in the beta channel to test new features or
test compatibility with future releases.
Don’t use beta releases for production environments. 

Versioning for releases in the **beta** channel of the Dart SDK
follows the `x.y.z-a.b.beta` format.
Version strings resemble `2.8.0-20.11.beta`.
The part before the hyphen follows the stable version format.
The part after the hyphen adds the pre-release version (`a`),
then the pre-release patch version (`b`), and then the channel (`beta`).

### Dev
Dart releases a build to the **dev** channel about twice a week.
The current dev version is  `[calculating]`{:.build-rev-dev}.

These dev channel builds include the most recent codebase with latest changes.
These builds may be broken, have no support,
and may contain unvetted breaking changes.

Versioning for releases in the **dev** channel of the Dart SDK
follows the `x.y.z-a.b.dev` format.
Version strings resemble `2.8.0-20.11.dev`.
Dev releases follow the beta channel versioning format replacing `beta` with `dev`.

Additional context

Originally raised as part of #4410.

@atsansone atsansone added the fix.refactor Needs near total rewrite or reorganization of content label Dec 5, 2022
@atsansone atsansone self-assigned this Dec 5, 2022
@parlough parlough added p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. a.get-started Relates to Getting Started with Dart e1-hours Can complete in < 8 hours of normal, not dedicated, work labels Dec 5, 2022
@atsansone atsansone added the st.triage.ltw Indicates Lead Tech Writer has triaged label Apr 21, 2023
atsansone added a commit to atsansone/site-www that referenced this issue Feb 20, 2024
atsansone added a commit to atsansone/site-www that referenced this issue Mar 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a.get-started Relates to Getting Started with Dart e1-hours Can complete in < 8 hours of normal, not dedicated, work fix.refactor Needs near total rewrite or reorganization of content p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. st.triage.ltw Indicates Lead Tech Writer has triaged
Projects
None yet
2 participants