Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 1.88 KB

README.md

File metadata and controls

65 lines (41 loc) · 1.88 KB

Rails Documentation Server Support

Dependencies

  • RVM

  • rvm install 2.5.3

  • rvm use 2.5.3 do gem install bundler -v 1.16.1 --no-rdoc --no-ri

  • kindlegen must be in PATH (download))

  • Install imagemagick, for convert, used by the guides generator

    • Linux: sudo apt-get install imagemagick
    • macOS: brew install imagemagick

  • Nokogiri's dependencies (present in some Gemfiles):

The Ruby and bundler dependencies are not hard, we fix concrete versions because these are known to work. Ruby and bundler versions are configurable per release, so this is forward-compatible, just add new versions if needed and configure their target generator to use them.

Locale

Make sure the locale is UTF8, in Linux/macOS run locale and see if the values are "en_US.UTF-8" in general.

In Ubuntu edit the file /etc/default/locale and put

LC_ALL=en_US.UTF-8
LANG=en_US.UTF-8

RVM

Be sure to have rvm binaries in your PATH to make RVM scripting work correctly.

  • With fish shell, in ~/.config/fish/config.fish:
set -gx PATH $HOME/.rvm/bin $PATH

Nokogiri

You might need to do bundle config build.nokogiri --use-system-libraries on macOS to have nokogiri compile.

Deployment

Just push to master. The cron job in the docs server pulls before invoking the docs generator.

Test Suite

In order to run the test suite you need a recent version of minitest:

  • gem install minitest -N

There are two tasks: The default task, test, tests everything except actual docs generation. The test:all task runs the entire suite including doc generation for a few releases, this one takes about 20 minutes on my laptop.