-
Notifications
You must be signed in to change notification settings - Fork 210
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
Add docs to consume preview packages #544
Add docs to consume preview packages #544
Conversation
You can try these changes at https://cadlplayground.z22.web.core.windows.net/prs/544/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One question and a couple of minor suggested clarifications
README.md
Outdated
On every commit to the main branch, packages with changes are automatically packaged and published under the `@next` tag under npm. | ||
In the [packages](#packages) section each package has a `@next` tag which show its current next version. | ||
|
||
To use a `nightly` version of the packages update go over each one of the packages in the `package.json` fie and update it to either the latest published `@next` version or `@latest`, which ever is the newest. (You can also use the tag `latest` or `next`) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are we saying that they can use the tag 'next' or 'latest' in their package.json files? Or do we want them to be explicit about version and not use the tags?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They can use either. For next
I think it doesn't matter, next
be maybe simpler. For latest
we maybe should decide when we go to 1.0 if we want people to try to always use the latest version or be tied to a major, minor version
Co-authored-by: Mark Cowlishaw <[email protected]>
Co-authored-by: Mark Cowlishaw <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wording suggestions you can take or leave.
Co-authored-by: Brian Terlson <[email protected]>
Co-authored-by: Brian Terlson <[email protected]>
Co-authored-by: Brian Terlson <[email protected]>
Co-authored-by: Brian Terlson <[email protected]>
fix #494