Make sure you execute rake rdoc from rails root directory [ci skip] #19932
Conversation
|
Ah ok sure. |
|
@axilleas thanks man 💛 |
axilleas
force-pushed
the
api_docs_guidelines
branch
from
3eeeadc
to
d3f06c6
Compare
|
No problem, it's the commit messages that give me headaches so I try to split the PRs but I feel you :) It should be fixed. lol I missed your heart emoticons back when you helped at the GitLab bug tracker 😄 |
|
@axilleas feel free to use multiline-commit messages. |
|
Good! Question, are you "into" a directory? |
axilleas
force-pushed
the
api_docs_guidelines
branch
from
d3f06c6
to
ce0ccd7
Compare
|
@senny amended commit to match your recomendation. @fxn actually I kinda copy-pasted from https://github.com/rails/rails/blob/master/guides/source/ruby_on_rails_guides_guidelines.md#generation 😄 |
|
@axilleas yeah, you can "cd into", but "be into"... not sure about that one :). |
| @@ -16,7 +16,8 @@ RDoc | |||
| ---- | |||
|
|
|||
| 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 | |||
| into the `rails` root directory, run `bundle install` and execute: | |||
There was a problem hiding this comment.
I'm with @fxn. into feels off here.
make sure you are in the rails root directory.
axilleas
force-pushed
the
api_docs_guidelines
branch
from
ce0ccd7
to
f51ad96
Compare
|
Ah I see what you mean, updated. And yeah "be into" has a different meaning. |
| @@ -16,7 +16,8 @@ RDoc | |||
| ---- | |||
|
|
|||
| 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: | |||
There was a problem hiding this comment.
probably better not to quote rails.
There was a problem hiding this comment.
Fair enough. I took it from the generation section of the HTML Guides where guides as a dir is also quoted ;)
There was a problem hiding this comment.
yea but guides/ is an actual dir, while rails just refers to the folder you cloned rails into. We can't really know what it's called. Hence I see "the rails root directory" as the thing we are pointing to, not the directory rails/.
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
axilleas
force-pushed
the
api_docs_guidelines
branch
from
f51ad96
to
86b6c77
Compare
Make sure you execute rake rdoc from rails root directory [ci skip]
|
@axilleas thank you for your contribution. |
|
Thank you for your time and support :) |
\cc @senny