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

Without these details, installation is off-putting to newcomers #3

Merged
merged 4 commits into from
Oct 20, 2017

Conversation

martinhbramwell
Copy link
Contributor

As a newcomer to Vulcan it annoyed me to have to repeatedly back track and retry, before I could get a clean install.

Signed-off-by: Martin Bramwell <martinhbramwell@gmail.com>
Signed-off-by: Martin Bramwell <martinhbramwell@gmail.com>
Signed-off-by: Martin Bramwell <martinhbramwell@gmail.com>
@SachaG
Copy link
Contributor

SachaG commented Oct 17, 2017

That's a really good write-up but I feel like the amount of steps might give the impression that the install is more complex than it actually is.

How about first adding an "Install" section that only has the basics (npm install, meteor, etc.) and then putting your detailed write-up below that in a "Full Instructions" section?

@martinhbramwell
Copy link
Contributor Author

New commit!
Does that work better for you?

@SachaG
Copy link
Contributor

SachaG commented Oct 19, 2017

Sorry for nit-picking, but is specifying environment variables really necessary? I feel like the simple install should just be as simple as possible? Other than that, it's great :)

@martinhbramwell
Copy link
Contributor Author

I understand it makes it look more complicated than you'd like, but I have my reasons :

  • Once those 3 shellvars are prepared, your Linux users will directly up and running with 4 drag'n drops,
  • To be sufficiently accurate and complete, such that a new visitor perceives no ambiguity, I'd have to explain where to put things in order to be sure they got export METEOR_PACKAGE_DIRS=${VULCAN_HOME}/packages; working correctly.

I have done a lot of OSS project evaluations. If the first hour of experience proves tricky I will abandon the project much more quickly than if I'm up & running in a few minutes. You have put a huge amount of effort into documentation, videos and tutorials, so I don't think you want people tripping over mops and buckets when they try to get in the front door, especially Meteor people who expect to get there with a single command.

Actually, now I'm concerned that on the 2nd run through they're going to hit an immediate mysterious snag -- METEOR_PACKAGE_DIRS will be undefined, and the only information will be a very unhelpful stack trace.

@SachaG SachaG merged commit ede53e2 into VulcanJS:master Oct 20, 2017
@SachaG
Copy link
Contributor

SachaG commented Oct 20, 2017

Thanks, I merged this and then simplified the quick install walkthrough myself. I think people don't need to bother with the 2-repo install method at first.

@martinhbramwell
Copy link
Contributor Author

Great! I should have the Chimp/Cucumber example for you by early next week.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants