mirror of
https://github.com/meteor/meteor.git
synced 2026-05-02 03:01:46 -04:00
Merge branch 'devel' into release-3.0.2
This commit is contained in:
@@ -759,7 +759,13 @@ jobs:
|
||||
- run:
|
||||
name: Cloning "meteor" Repository's current branch
|
||||
command: |
|
||||
git clone --branch $CIRCLE_BRANCH https://github.com/meteor/meteor.git ${CHECKOUT_METEOR_DOCS}
|
||||
if [[ -n "$CIRCLE_PULL_REQUEST" ]]; then
|
||||
PR_NUMBER=$(echo $CIRCLE_PULL_REQUEST | sed 's|.*/pull/\([0-9]*\)|\1|')
|
||||
PR_BRANCH=$(curl -s https://api.github.com/repos/meteor/meteor/pulls/$PR_NUMBER | jq -r .head.ref)
|
||||
git clone --branch $PR_BRANCH https://github.com/meteor/meteor.git ${CHECKOUT_METEOR_DOCS}
|
||||
else
|
||||
git clone --branch $CIRCLE_BRANCH https://github.com/meteor/meteor.git ${CHECKOUT_METEOR_DOCS}
|
||||
fi
|
||||
# Run almost the same steps the meteor/docs repository runs, minus deploy.
|
||||
- run:
|
||||
name: Generating Meteor documentation for JSDoc testing
|
||||
|
||||
@@ -2,8 +2,8 @@ import { defineConfig } from "vitepress";
|
||||
|
||||
// https://vitepress.dev/reference/site-config
|
||||
export default defineConfig({
|
||||
title: "Meteor Docs",
|
||||
description: "Meteor.js API Docs",
|
||||
title: "Docs",
|
||||
description: "Meteor.js Docs",
|
||||
head: [
|
||||
["link", { rel: "icon", href: "/logo.png" }],
|
||||
[
|
||||
@@ -26,12 +26,79 @@ export default defineConfig({
|
||||
themeConfig: {
|
||||
// https://vitepress.dev/reference/default-theme-config
|
||||
nav: [
|
||||
{ text: "Deploy", link: "https://www.meteor.com/cloud" },
|
||||
{
|
||||
text: "Tutorials",
|
||||
link: "https://www.meteor.com/developers/tutorials",
|
||||
text: 'Docs',
|
||||
activeMatch: `^/(guide|docs|examples)/`,
|
||||
items: [
|
||||
|
||||
{ text: 'Quick Start', link: '/about/install' },
|
||||
{ text: 'Examples', link: 'https://github.com/meteor/examples' },
|
||||
{
|
||||
text: 'Meteor.js 2 Docs',
|
||||
link: 'https://v2-docs.meteor.com'
|
||||
},
|
||||
{
|
||||
text: 'Migration from Meteor.js 2',
|
||||
link: 'https://v3-migration-docs.meteor.com'
|
||||
}
|
||||
]
|
||||
},
|
||||
{ text: "Forums", link: "https://forums.meteor.com/" },
|
||||
{
|
||||
text: 'Ecosystem',
|
||||
activeMatch: `^/ecosystem/`,
|
||||
items: [
|
||||
{
|
||||
text: 'Community & Help',
|
||||
items: [
|
||||
{
|
||||
text: 'Meteor Forums',
|
||||
link: 'https://forums.meteor.com'
|
||||
},
|
||||
{
|
||||
text: 'Meteor Lounge Discord',
|
||||
link: 'https://discord.gg/hZkTCaVjmT'
|
||||
},
|
||||
{
|
||||
text: 'GitHub Discussions',
|
||||
link: 'https://github.com/meteor/meteor/discussions'
|
||||
},
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Resources',
|
||||
items: [
|
||||
{ text: 'Packages on Atmosphere', link: 'https://atmospherejs.com/' },
|
||||
{ text: 'VS Code Extension', link: 'https://marketplace.visualstudio.com/items?itemName=meteor-toolbox.meteor-toolbox' },
|
||||
{ text: 'DevTools - Chrome Extension', link: 'https://chromewebstore.google.com/detail/ibniinmoafhgbifjojidlagmggecmpgf' },
|
||||
{ text: 'DevTools - Firefox Extension', link: 'https://addons.mozilla.org/en-US/firefox/addon/meteor-devtools-evolved/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Learning',
|
||||
items: [
|
||||
{
|
||||
text: 'Meteor University',
|
||||
link: 'https://university.meteor.com'
|
||||
},
|
||||
{
|
||||
text: 'Youtube Channel',
|
||||
link: 'https://www.youtube.com/@meteorsoftware'
|
||||
},
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'News',
|
||||
items: [
|
||||
{ text: 'Blog on Dev.to', link: 'https://dev.to/meteor' },
|
||||
{ text: 'Blog on Medium', link: 'https://blog.meteor.com' },
|
||||
{ text: 'Twitter', link: 'https://x.com/meteorjs' },
|
||||
{ text: 'LinkedIn', link: 'https://www.linkedin.com/company/meteor-software/' },
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{ text: "API", link: "/api/" },
|
||||
{ text: "Galaxy Cloud", link: "https://www.meteor.com/cloud" },
|
||||
],
|
||||
sidebar: [
|
||||
{
|
||||
@@ -296,7 +363,13 @@ export default defineConfig({
|
||||
},
|
||||
],
|
||||
|
||||
socialLinks: [{ icon: "github", link: "https://github.com/meteor/meteor" }],
|
||||
socialLinks: [{ icon: "github", link: "" }],
|
||||
socialLinks: [
|
||||
{ icon: 'github', link: 'https://github.com/meteor/meteor' },
|
||||
{ icon: 'twitter', link: 'https://x.com/meteorjs' },
|
||||
{ icon: 'discord', link: 'https://discord.gg/hZkTCaVjmT' }
|
||||
],
|
||||
|
||||
logo: { dark: "/meteor-logo.png", light: "/meteor-blue.png" },
|
||||
|
||||
search: {
|
||||
@@ -318,7 +391,7 @@ export default defineConfig({
|
||||
'Copyright (c) 2011 - present <a href="https://www.meteor.com/">Meteor Software</a>.',
|
||||
},
|
||||
editLink: {
|
||||
pattern: "https://github.com/meteor/meteor/edit/release-3.0/v3-docs/docs/:path",
|
||||
pattern: "https://github.com/meteor/meteor/edit/devel/v3-docs/docs/:path",
|
||||
text: "Edit this page on GitHub",
|
||||
},
|
||||
},
|
||||
|
||||
@@ -3,6 +3,9 @@
|
||||
|
||||
You need to install the Meteor command line tool to create, run, and manage your Meteor.js projects. Check the prerequisites and follow the installation process below.
|
||||
|
||||
```bash
|
||||
npx meteor
|
||||
```
|
||||
|
||||
## Prerequisites {#prereqs}
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ Meteor is a full-stack JavaScript platform for developing modern web and mobile
|
||||
|
||||
- Participate in Meteor's fully professional, engaging and interactive online school. Join [Meteor University](https://university.meteor.com/).
|
||||
|
||||
- Subscribe to our official [Youtube channel](https://www.youtube.com/@MeteorVideos) and watch the latest MeteorJS videos and presentations.
|
||||
- Subscribe to our official [Youtube channel](https://www.youtube.com/@meteorsoftware) and watch the latest MeteorJS videos and presentations.
|
||||
|
||||
### Developer Resources
|
||||
|
||||
@@ -48,6 +48,6 @@ Meteor is a full-stack JavaScript platform for developing modern web and mobile
|
||||
|
||||
- Participate in the [Official Forum](https://forums.meteor.com) for project news, support, community discussions, and updates on core features.
|
||||
|
||||
- Engage with peers in the [Meteor Slack Community](https://join.slack.com/t/meteor-community/shared_invite/enQtODA0NTU2Nzk5MTA3LWY5NGMxMWRjZDgzYWMyMTEyYTQ3MTcwZmU2YjM5MTY3MjJkZjQ0NWRjOGZlYmIxZjFlYTA5Mjg4OTk3ODRiOTc) for technical support, meeting new developers, and exchanging ideas.
|
||||
- Join the discussion and stay updated with announcements on the official [Meteor Lounge Discord](https://discord.gg/hZkTCaVjmT).
|
||||
|
||||
- Join the discussion and stay updated with announcements on the [Meteor Discord Community](https://discord.gg/mukjwCA56P).
|
||||
- Engage with peers in the [Meteor Slack Community](https://join.slack.com/t/meteor-community/shared_invite/enQtODA0NTU2Nzk5MTA3LWY5NGMxMWRjZDgzYWMyMTEyYTQ3MTcwZmU2YjM5MTY3MjJkZjQ0NWRjOGZlYmIxZjFlYTA5Mjg4OTk3ODRiOTc) for technical support, meeting new developers, and exchanging ideas.
|
||||
|
||||
@@ -3,8 +3,8 @@
|
||||
layout: home
|
||||
|
||||
hero:
|
||||
text: "Meteor Docs"
|
||||
tagline: "All the documentation you need to build and deploy your app with Meteor."
|
||||
text: "Meteor.js Docs"
|
||||
tagline: "Documentation, resources, and API references to help you build and deploy with Meteor.js."
|
||||
image:
|
||||
src: /logo.png
|
||||
alt: Meteor
|
||||
|
||||
@@ -12,7 +12,7 @@ The migration will look like this:
|
||||
```js
|
||||
// in you package.js
|
||||
Package.onUse((api) => {
|
||||
api.versionsFrom(['1.10', '2.3', '3.0-rc.2']);
|
||||
api.versionsFrom(['1.10', '2.3', '3.0']);
|
||||
// ^^^^^^^ for testing your package with meteor 3.0
|
||||
|
||||
api.versionsFrom(['1.10', '2.3', '3.0']);
|
||||
@@ -20,7 +20,7 @@ Package.onUse((api) => {
|
||||
});
|
||||
```
|
||||
|
||||
Then you can publish your package and test it with Meteor 3.0, by running `meteor publish --release=3.0-rc.2`.
|
||||
Then you can publish your package and test it with Meteor 3.0, by running `meteor publish --release=3.0.1`.
|
||||
|
||||
|
||||
## Changes for packages that do not use Meteor packages that had breaking change
|
||||
@@ -33,7 +33,7 @@ by adding the following line to your `package.js`:
|
||||
```js
|
||||
// in you package.js
|
||||
Package.onUse((api) => {
|
||||
api.versionsFrom(['1.10', '2.3', '3.0-rc.2']);
|
||||
api.versionsFrom(['1.10', '2.3', '3.0']);
|
||||
// ^^^^^^^ for testing your package with meteor 3.0
|
||||
|
||||
api.versionsFrom(['1.10', '2.3', '3.0']);
|
||||
|
||||
@@ -14,7 +14,7 @@ from Ben Newman and this Stack Overflow [answer](https://stackoverflow.com/a/408
|
||||
|
||||
## What is the Meteor v3 release schedule?
|
||||
|
||||
Our current plan is to release Meteor v3 until Q2 2024. This is subject to change as we progress through the development of Meteor v3.
|
||||
Meteor 3 official version is already out! You can check our posts about it on the [Forums](https://forums.meteor.com/t/its-official-meteor-3-0-official-release-is-out/61860) and [blog](https://dev.to/meteor/meteor-3-is-officially-here-3gml).
|
||||
|
||||
## Will MongoDB Collection Methods be removed from the client?
|
||||
|
||||
@@ -98,9 +98,7 @@ You can check more information on the [react page](../front-end/react.md).
|
||||
|
||||
## When will Blaze be ready for version 3.0?
|
||||
|
||||
The team considered Blaze adjustments to version 3.0 done, version 2.9 and upper are with all features regarding async APIs.
|
||||
|
||||
You can check more information on the [Blaze page](../front-end/blaze.md).
|
||||
Blaze 3 is out and compatible with Meteor 3. You can check the post about it [here](https://forums.meteor.com/t/blaze-3-is-out/61861).
|
||||
|
||||
## When will XYZ package be ready for version 3.0?
|
||||
|
||||
@@ -113,5 +111,3 @@ For those packages that are not in the core but are maintained by the [community
|
||||
we hope that the community can work on them, but if for some reason that is not possible,
|
||||
you can always ping us on [Slack](https://join.slack.com/t/meteor-community/shared_invite/zt-28aru814j-AwswQGt2D1xIXurvmtJvug) or in the [Forums](https://forums.meteor.com/).
|
||||
|
||||
Following the official release of Meteor 3.0, we plan to add new packages to the core and migrating them to Meteor 3.0.
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
## Publishing Packages
|
||||
|
||||
Publishing a Meteor package involves a few key steps, including setting up your package, testing it, and finally publishing it to the Meteor package repository. Here's a brief guide on how to publish Meteor packages using Meteor 3, specifically with the `meteor publish --release=3.0-rc.2` command.
|
||||
Publishing a Meteor package involves a few key steps, including setting up your package, testing it, and finally publishing it to the Meteor package repository. Here's a brief guide on how to publish Meteor packages using Meteor 3, specifically with the `meteor publish --release=3.0.1` command.
|
||||
|
||||
### Prerequisites
|
||||
- Ensure you have Meteor 3 installed. You can check your Meteor version and automatically download it if it's missing:
|
||||
```bash
|
||||
meteor --version --release=3.0-rc.2
|
||||
meteor --version --release=3.0.1
|
||||
```
|
||||
- Have a Meteor developer account. You can create one at [Meteor's official website](https://www.meteor.com/).
|
||||
|
||||
@@ -35,7 +35,7 @@ Package.describe({
|
||||
});
|
||||
|
||||
Package.onUse(function(api) {
|
||||
api.versionsFrom('3.0-rc.2');
|
||||
api.versionsFrom('3.0');
|
||||
api.use('ecmascript');
|
||||
api.mainModule('my-package.js');
|
||||
});
|
||||
@@ -51,7 +51,7 @@ Package.onTest(function(api) {
|
||||
If the package is also intended to work with Meteor 2 you can use:
|
||||
|
||||
```javascript
|
||||
api.versionsFrom(['2.3', '3.0-rc.2']);
|
||||
api.versionsFrom(['2.3', '3.0']);
|
||||
```
|
||||
|
||||
3. **Create the main module file:**
|
||||
@@ -87,10 +87,10 @@ meteor test-packages ./ --driver-package meteortesting:mocha
|
||||
Once your package is ready and tested, you can publish it using the following command:
|
||||
|
||||
```bash
|
||||
meteor publish --release=3.0-rc.2
|
||||
meteor publish --release=3.0.1
|
||||
```
|
||||
|
||||
You can replace `3.0-rc.2` with the appropriate release version. If you omit the `--release` flag, it will default to the latest official Meteor version, which at the time of this writing is Meteor 2. That way packages published without specifying a release will not be compatible with Meteor 3, as there will probably be a `fibers` related error.
|
||||
You can replace `3.0.1` with the appropriate release version. If you omit the `--release` flag, it will default to the latest official Meteor version, which at the time of this writing is Meteor 2. That way packages published without specifying a release will not be compatible with Meteor 3, as there will probably be a `fibers` related error.
|
||||
|
||||
- **Login if prompted:**
|
||||
You will be asked to log in with your Meteor developer account credentials if you aren't already logged in.
|
||||
@@ -110,4 +110,4 @@ meteor add user:package
|
||||
- **Documentation:** Provide thorough documentation in the `README.md` file to help users understand how to use your package.
|
||||
- **Git Repository:** Keep your package source code in a version-controlled repository like GitHub for easy collaboration and updates.
|
||||
|
||||
By following these steps, you should be able to publish your Meteor packages with Meteor 3 successfully. Happy coding!
|
||||
By following these steps, you should be able to publish your Meteor packages with Meteor 3 successfully. Happy coding!
|
||||
|
||||
@@ -9,9 +9,9 @@ This guide is for users with Meteor 2.x projects understand the changes between
|
||||
|
||||
## What's the status of version 3.0?
|
||||
|
||||
Meteor 3.0 is currently in its Release Candidate (RC) phase, a nearly final version ready for final testing ahead of the official launch.
|
||||
Meteor 3.0 is currently in its official version!
|
||||
|
||||
**Latest version:** `3.0-rc.10` <br/>
|
||||
**Latest version:** `3.0.1` <br/>
|
||||
**Node.js version:** `20.15.1 LTS` <br/>
|
||||
**NPM version:** `10.7.0`
|
||||
|
||||
@@ -20,7 +20,7 @@ Meteor 3.0 is currently in its Release Candidate (RC) phase, a nearly final vers
|
||||
You can create a new Meteor 3.0 project by running the command below:
|
||||
|
||||
```bash
|
||||
meteor create my-new-project --release 3.0-rc.4
|
||||
meteor create my-new-project --release 3.0.1
|
||||
```
|
||||
|
||||
## How to upgrade from Meteor 2.x?
|
||||
@@ -28,7 +28,7 @@ meteor create my-new-project --release 3.0-rc.4
|
||||
You can upgrade your Meteor 2.x project by running the command below inside your project folder:
|
||||
|
||||
```bash
|
||||
meteor update --release 3.0-rc.4
|
||||
meteor update --release 3.0.1
|
||||
meteor reset # resets project to a fresh state
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user