phusion / passenger_library

Phusion Passenger documentation
https://www.phusionpassenger.com/docs
Other
48 stars 111 forks source link

Update Meteor docs to reflect version 1.6 #64

Open serkandurusoy opened 6 years ago

serkandurusoy commented 6 years ago

MDG has just released Meteor version 1.6 and will be pushing this as the recommended release on Monday.

This calls for an update in the passenger library because:

@dr-dimitru and I are willing to create a PR for this if you guys have not already begun work yourselves.

serkandurusoy commented 6 years ago

@FooBarWidget @OnixGH hey sorry for directly pinging you but since this is one of the biggest releases of Meteor - a long awaited one - ever, also rendering the current docs out of date, I thought I'd push this forward :)

OnixGH commented 6 years ago

@serkandurusoy we haven't started on it yet (the Meteor 1.6 API docs don't seem to be available yet), so it would be great if you guys want to submit a PR!

Regarding our beginners' tutorial, the Meteor version picker in the Node install step indeed needs to be updated.

I don't know much about the other options, but please keep in mind that we don't aim to become the prime source for help with using Meteor itself. The tutorial in particular is meant for beginners to get something basic up and running that they can use in production; too much information there would probably be confusing.

I think we moved most of the background information that does matter for use with Passenger into the About Meteor support section, so that might be a good place for some advanced hints.

Regarding the static files, it's unfortunate how Meteor scatters things, we're still thinking about whether we can do anything about that, for now my opinion would be to work in some hints into the (non-beginner) deployment doc. Even if something can reasonably be done on the Passenger side, I don't see it coming out in a nearby release anyway so the docs could cover that.

dr-dimitru commented 6 years ago

Hello @OnixGH ,

Thank you for update on this.

we haven't started on it yet (the Meteor 1.6 API docs don't seem to be available yet), so it would be great if you guys want to submit a PR!

Meteor's API won't change. The only biggest step is the Node upgrade to 8.8.1 and NPM to 5.5.1 it won't affect Phusion Passenger integration in any way. But it should be mentioned what Meteor.js has specific requirements to Node and NPM versions. Correct me if I'm wrong.

Regarding the static files, it's unfortunate how Meteor scatters things, we're still thinking about whether we can do anything about that, for now my opinion would be to work in some hints into the (non-beginner) deployment doc. Even if something can reasonably be done on the Passenger side, I don't see it coming out in a nearby release anyway so the docs could cover that.

Actually docs is already covering this, but:

  1. It's not obvious
  2. Not everyone reading docs carefully
  3. Most of developers believe into Phusion Passenger's magic

I'm highlighted important parts, from existing docs:

Phusion Passenger leverages this property to make your life easier. It assumes this convention by default so that you don't have to write so much configuration. If your app does not follow the convention then there are configuration options to tell Phusion Passenger about the structure.

According to Phusion Passenger's convention, you will need two extra directories in your Meteor app directory:

  • public/ - The same directory used by Meteor for static files. All files in this directory will automatically be served by the web server, bypassing Meteor. For example, if there's a file public/foo.jpg, then any requests to /foo.jpg will be handled by the web server, and never passed to the application.

For simplicity reasons, this tutorial assumes that your app follows this convention. If you prefer to put the public and tmp directories elsewhere then that's entirely possible. The manuals tell you how to configure their locations.

Forum threads like this one is common, and docs should definitely updated, there is many confused developers.

I belive it should be continued here in #1996

OnixGH commented 6 years ago

@dr-dimitru like I said, a doc change PR would be welcomed and I encourage you guys to have a go at it.

Just keep in mind that it matters in which section you put what (beginners vs. advanced / in-depth); it's clear that what you linked should also be updated, but focusing on what pertains to use in combination with Passenger.

serkandurusoy commented 6 years ago

@OnixGH have you huys already begun working on an update yet? Otherwise I might (finally) have some free time to start a PR.

OnixGH commented 6 years ago

@serkandurusoy go ahead (we've been busy preparing 5.1.12).