molybdenum-99 / reality

Comprehensive data proxy to knowledge about real world
MIT License
817 stars 43 forks source link

Nitrous.io "Quickstart" Button for main readme. #63

Closed 5car1z closed 8 years ago

5car1z commented 8 years ago

Hi guys,

Recently Nitrous have added a new feature to their platform named “Quickstarts”. This feature lets users create pre-configured development environments on the service at the click of a button. Nitrous are trying to set up these Quickstarts for users by requesting that projects like yourself host the Quickstart trigger button on your GitHub readme.

This would mean that if a Nitrous user wants a dev environment all set up and ready to use Reality with, then they can click the HTML button embedded on your readme, and then the Nitrous API will create one for them.

All that’s needed from yourselves is that you have the HTML trigger button embedded in the main README.md - for people to click (this is all done in these proposed changes for you).

The button links back to a separate repository with all the necessary Nitrous Quickstart config files - https://github.com/5car1z/nitrous-quickstart-reality and works through them.

Is this something you’d be up for helping us out with? There’s not much you have to do on your end, except merge this change into your master, so people can see the button.

Here’s some more links that help explain the process if interested:

Any questions do ask.

Thanks.

zverok commented 8 years ago

Faithfully, your pull request looks really strange for me. State in main README of open source and open data project that its user can signup some commercial service? ORLY?

I'll be VERY surprised, if any of self-respecting OSS projects accepts such shameless self-promotional change to their README.

We use many external services, like Gitter, TravisCI and (for other repos) CodeClimate and others. You know, how it stated in README? With small self-describing badge, nothing more. This is maximum "service promotion" you can expect.

5car1z commented 8 years ago

Maybe I should have pointed out that the Nitrous service is free to use by default, with subscription plans only for anyone wanting more system resources. The button itself is mostly for users to easily try out frameworks and projects with ease on the platform, once they find them on GitHub, free of charge.

Quite a few OS projects have had a previous iteration of the Quickstart feature as part of their readme's (when it was named the Nitrous Hack button) and they didn't seem to mind.

Maybe I have not explained the use or purpose of this feature very well, or just worded the readme commit badly. This is just a part of the Nitrous API that let's user's set up their projects quicker.

Either way thanks for your time, and sorry if this seems like self-promotion, that's not really the intent.

zverok commented 8 years ago

Sorry, I didn't want to offend you of course.

There are just several points I'd like to emphasize:

As a side note, I reviewed the "quickstart config" you've provided and I'm not sure it was some non-trivial thing (because it never specified reality's required Ruby version, necessary configurations and so on).

BTW,

Quite a few OS projects have had a previous iteration of the Quickstart feature as part of their readme's (when it was named the Nitrous Hack button) and they didn't seem to mind.

Never seen those before. Could you provide some examples?..