Document "Ruby ways" for prospective developers from other communities
Reported by Nicolas Dumazet | November 24th, 2009 @ 02:23 AM
Hello!
I came to amp after this mercurial-devel thread. Browsing the website, I found a few content errors, that I decided to fix.
After my fixes, I wanted to build the website to test my changes. Without a few hints, this step can turn up to suck up much more time than expected for folks coming from Python/C/[communities other than Ruby].
If you want to get more people interested, you might want to spend some time at some point to create Ruby-newb-friendly documentation.
Namely:
- how to install the dependencies needed to build locally amp
and/or the website from sources
- finding net/https can be difficult for ruby newcomers
- wait, "uv" is ultraviolet?
- This snippet maybe? (If you forget about the harmful "add /usr/local/lib to /etc/so.conf" suggestion)
- ...
- how to run a development instance of the website (If one naively calls "firefox site/build/index.html" after building the site, he will have mixed results due to the root-relative rendered paths: "/about/performance.html", "/scripts/:.js", etc...)
And there are probably other interesting points to improve for amp code itself. Think of the Ruby-only ways, and document them/add useful pointers, please :)
This might not be a top-priority ticket for now. Motivated developers will always find their way around your codebase/workflows. But you might want to look more attractive ;)
Cheers,
Comments and changes to this ticket
-
Michael J. Edgar December 20th, 2009 @ 03:50 AM
- State changed from “new” to “open”
Thanks for the suggestions, Nicolas!
I'm sorry we didn't respond to this sooner. Unfortunately us two core guys are students, and the end of our term was just kicking in when we released amp.
We've already done some good work in making building the site a bit simpler (helpful explanation when you don't have the right libraries installed), and I just added the oniguruma link you provided to the message. Over the next couple weeks, along with doing a push to improve Amp's code, we'll be fleshing out our Wiki on BitBucket to provide a lot of the things you've suggested.
Thanks again!
Michael Edgar
Please Sign in or create a free account to add a new ticket.
With your very own profile, you can contribute to projects, track your activity, watch tickets, receive and update tickets through your email and much more.
Create new ticket
Create your profile
Help contribute to this project by taking a few moments to create your personal profile. Create your profile ยป
Rethink Version Control.- http://amp.carboni.ca/
Amp aims to put control of version-control software in your hands as a developer. The entire system is written in Ruby (with C extensions to improve performance), and aims to implement all major VCS's in Ruby. Currently, Mercurial is implemented.
Other features:
Commands are first-class members of the system - drop in an "Ampfile" in your repository, and you can add commands to amp in the same manner you add commands to rake (only with far, far more power!)
Documentation is one of our biggest priorities. We require all methods to be documented - even comically simple ones.
Heavy testing.
Multiple "workflows" - use git's commands to power a mercurial repository.
Add hooks/callbacks in minutes.
Michael J. Edgar