kotovalexarian-likes-github/rails--rails
1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Code Releases Activity

Update instructions to build guides locally [ci skip]

Browse source 
1. Make clear where rake rdoc is executed
2. Make clear where the generated HTML files for the guides are stored
3. Use bundler 1.3.5 or later
This commit is contained in:
Achilleas Pipinellis 2015-04-28 12:47:39 +03:00
parent cdf3548a45
commit 86b6c77337
2 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
guides/source/api_documentation_guidelines.md
View file

@ -16,7 +16,8 @@ RDoc
---- ----
The [Rails API documentation](http://api.rubyonrails.org) is generated with The [Rails API documentation](http://api.rubyonrails.org) is generated with
[RDoc](http://docs.seattlerb.org/rdoc/). [RDoc](http://docs.seattlerb.org/rdoc/). To generate it, make sure you are
in the rails root directory, run `bundle install` and execute:
```bash ```bash
bundle exec rake rdoc bundle exec rake rdoc

6
guides/source/ruby_on_rails_guides_guidelines.md
View file

@ -64,7 +64,9 @@ The guides and the API should be coherent and consistent where appropriate. In p
HTML Guides HTML Guides
----------- -----------
Before generating the guides, make sure that you have the latest version of Bundler installed on your system. As of this writing, you must install Bundler 1.3.5 on your device. Before generating the guides, make sure that you have the latest version of
Bundler installed on your system. As of this writing, you must install Bundler
1.3.5 or later on your device.
To install the latest version of Bundler, run `gem install bundler`. To install the latest version of Bundler, run `gem install bundler`.
@ -82,6 +84,8 @@ or
bundle exec rake guides:generate:html bundle exec rake guides:generate:html
``` ```
Resulting HTML files can be found in the `./output` directory.
To process `my_guide.md` and nothing else use the `ONLY` environment variable: To process `my_guide.md` and nothing else use the `ONLY` environment variable:
``` ```