rubymotion documentation project
How to Contribute
This repo is the product of generating the
build branch using StrangeCase,
and then pushing the result to the
Clone this repo
git clone email@example.com:rubymotion/rubymotion.github.com
You will be in the
buildbranch, which is where you will edit the templates and such.
pip install strangecase
Clone again, specifying the master branch, into the public/ folder. When you commit and push this folder, your changes will be made live, and this is also the folder that is served using the
scase --servecommand. If you run a webserver locally, it is faster to point it to this folder than to use the built-in
git clone -b master firstname.lastname@example.org:rubymotion/rubymotion.github.com public
The downside is that we have this "two branch" system, whereas using jekyll you can just have one branch, and site is generated by github. But if you want to work locally, you need to install jekyll, so you end up pretty much the same either way.
The files will be generated in the
public/folder within the rubymotion.github.com project folder. Run a server in that folder, or use the StrangeCase built-in
servecommand (which you run from the project folder, not the public/ folder). In another tab or terminal window,
cdto rubymotion.github.com/ and run:
Make changes, commit to
build, push, and create a pull request. Someone will pull, generate the site again locally, and then push to
masterso that the site is visible to the world.
I would like to make this process easier! Way too many steps. A Rakefile with these tasks would be super great.
Because I (colinta) am creating these documents, and I created StrangeCase! But the irony of using a python project to generate documentation that is aimed at rubyists is not lost on me. I would prefer to be using jekyll. Please fork and make us a jekyll version. I promise it will get merged in.