Merge branch 'master' into feature/publication-strategies

Author: StorytellerCZ

README.md

@@ -31,3 +31,37 @@ To generate the api boxes, the site uses a file `data/data.js` which is generate
 #### Starting hexo
 
 Ensure you've run `npm install`. Then simply `npm start`.
+
+### Developing with local meteor source
+
+When developing jsdoc documentation within the meteor code you will
+need to make some local modifications to get the documentation to work locally for testing.
+
+1. Modify `url` in `_config.yml` so links within `localhost:4000` will not jump out to `https://docs.meteor.com`
+```diff
+- url: http://docs.meteor.com/
++ url: http://localhost:4000/
+```
+2. reconnect the meteor submodule in `/code` to your local meteor folder.
+```bash
+# REMOVE submodule
+# Remove the submodule entry from .git/config
+git submodule deinit -f code
+
+# Remove the submodule directory from the superproject's
+# .git/modules directory
+rm -rf .git/modules/code
+
+# Remove the entry in .gitmodules and remove the submodule directory
+# located at path/to/submodule
+git rm -f code
+
+# ADD your local meteor submodule
+git submodule add /path/to/local/meteor code
+```
+
+3. Hexo builds if you are just changing md files in sources then
+hexo will watch for changes and update.  If you are making changes
+in the `/code` folder then you will need to `npm clean && npm start`.
+
+Of course, do not commit any of these changes.

_config.yml

@@ -1,6 +1,7 @@
 title: Meteor API Docs
 subtitle: API Docs
 versions:
+  - '2.4'
   - '2.3'
   - '2.2'
   - '2.1'

jsdoc/docdata-jsdoc-template/publish.js

@@ -48,7 +48,7 @@
     if (entry.meta && entry.meta.path) {
       var packagesFolder = 'packages/';
       var index = entry.meta.path.indexOf(packagesFolder);
-      if (index != -1) {
+      if (index != -1 && !entry.isprototype) {
         var fullFilePath = entry.meta.path.substr(index + packagesFolder.length) + '/' + entry.meta.filename;
         entry.filepath = fullFilePath;
         entry.lineno = entry.meta.lineno;

scripts/api-box.js

@@ -156,6 +156,7 @@ var importName = function(doc) {
   const noImportNeeded = !doc.module
     || doc.scope === 'instance'
     || doc.ishelper
+    || doc.isprototype
     || doc.istemplate;
 
   // override the above we've explicitly decided to (i.e. Template.foo.X)

source/api/core.md

@@ -3,6 +3,10 @@ title: Core
 description: Documentation of core Meteor functions.
 ---
 
+If you prefer to watch the video, click below. 
+
+{% youtube 6RRVU0-Vvm8 %}
+
 {% apibox "Meteor.isClient" %}
 {% apibox "Meteor.isServer" %}
 

source/api/pubsub.md

@@ -6,7 +6,9 @@ description: Documentation of Meteor's publication and subscription API.
 These functions control how Meteor servers publish sets of records and
 how clients can subscribe to those sets.
 
-If you prefer video watch [Meteor Publications 101](https://www.youtube.com/watch?v=RH2RxKgkPJY) in our [YouTube Channel](https://www.youtube.com/channel/UC3fBiJrFFMhKlsWM46AsAYw).
+If you prefer to watch the video, click below. 
+
+{% youtube RH2RxKgkPJY %}
 
 {% apibox "Meteor.publish" %}
 

source/install.md

@@ -2,6 +2,7 @@
 title: Install
 ---
 Meteor currently supports **OS X, Windows, and Linux**. Only 64-bit is supported.
+Apple M1 is only supported through Rosetta at this moment.
 
 ### Prerequisites and useful information
 
@@ -10,6 +11,7 @@ Meteor currently supports **OS X, Windows, and Linux**. Only 64-bit is supported
 - Disabling antivirus (Windows Defender, etc.) will improve performance.
 - For compatibility, Linux binaries are built with CentOS 6.4 i386/amd64.
 - iOS development requires the latest Xcode.
+- **Do not install meteor npm in your project's package.json by any means, the npm library is only an installer.**
 
 ### Installation
 
@@ -30,6 +32,19 @@ Only run the above command with sudo if you know what you are doing.
 
 If you only use sudo because of a distribution default permission system, [check this link for fixing it](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally).
 
+For Apple M1 computers, you can append Rosetta prefix as following:
+
+```bash
+
+arch -x86_64 npm install -g meteor
+
+```
+
+or select Terminal in the Applications folder, press CMD(⌘)+I and check the "Open using Rosetta" option.
+
+We currently don't support Apple M1 native binaries as the latest meteor release uses Node.js 14 which doesn't have support for it until now. More info in our repository, [here](https://github.com/meteor/meteor/issues/11249#issuecomment-734327204).
+
+
 ### Legacy Installation Method
 
 For Linux and OS X, we are still providing the legacy installation method which uses a bash script and doesn't depend on Node.