How to Contribute?
You can contribute by reporting errors or suggesting improvements. Just open an issue or pull request.
This is a big project with many translations involved. Please help us stay on top of things by following our guidelines for contributors.
The site uses Pygments for syntax highlighting. In order to generate the site locally, you need to have Python installed on your system (refer to the pygments.rb gem homepage for more detailed information).
Bundler will take care of the rest of the dependencies, so unless you already have done so, you might need to install bundler with:
gem install bundler
Then clone the repository and install the dependencies:
git clone https://github.com/ruby/www.ruby-lang.org.git cd www.ruby-lang.org/ bundle install
To generate the site and start a local web server, you can use
bundle exec rake serve
Then open http://localhost:9292/ in your local browser to access the preview.
Note: The build of the site will take several minutes.
If you created the site previously and the
already exists, the web server will start instantly.
It will serve the content as it was at the time of the last
site generation, though.
To force regeneration of the site or to only get feedback on the success of the build you might want to create the website without starting a local server instead:
bundle exec rake generate
Preview on Heroku
In case a build is not possible on your local machine you can also create a preview on Heroku.
git clone https://github.com/ruby/www.ruby-lang.org.git cd www.ruby-lang.org
- Create a feature branch.
- Make changes or add content and commit.
- Create preview app on Heroku using custom buildpack.
heroku login heroku create --buildpack http://github.com/ruby/heroku-buildpack-ruby-jekyll.git
- Push your site.
git push heroku feature_branch:master heroku open
To create a preview of the master branch:
git push heroku master heroku open
Besides generating and previewing the site you can perform additional tests with these tasks:
bundle exec rake check # perform various tests on the source files bundle exec rake check:markup # check markup for all generated pages bundle exec rake check:links # check for 404's (needs a running local server)
For more information see the wiki.