[DOC] No instructions on how to report docrails bugs #2858

Closed
jaylevitt opened this Issue Sep 4, 2011 · 6 comments

Projects

None yet

3 participants

@jaylevitt
Contributor

Back in April, Xavier Noria wrote:

Issues that one does not know how to fix, or that need discussion
should be reported to the Rails ticketing system, which is split
nowadays between LH and GitHub, but that has a brighter future in the
latter :). Please report there and assign them to me for example.

At the time, Rails guides included obsolete language about using the docrails issue tracker. That's been removed, but now there's no guidance on issue reporting at all. So I'm opening a ticket about the lack of instructions telling me to come here and open a ticket. It's very meta.

@smartinez87
Contributor

docrails is up and running again: https://github.com/lifo/docrails
And in this part of the guides explains how to contribute to the Rails Documentation: http://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#contributing-to-the-rails-documentation
@fxn is this ok, or am I missing something?

@fxn
Member
fxn commented Sep 4, 2011

@jaylevitt there's a bit of confusion about what's docrails.

docrails is only a way to bypass the ordinary workflow for issues or pull requests. It is not a project.

Issues about documentation, like issues for code or tests (eg, missing tests, tests issuing warnings), are Rails issues. You need to report them in rails/rails.

@fxn fxn closed this Sep 4, 2011
@jaylevitt
Contributor

@fxn please reopen: My point is that the docs in docrails should explain that issues should be reported on the rails/rails tracker As @smartinez87's comment shows, there is still some confusion about that, and as it stands, the docs don't say anything about what to do if you find errors (unless you yourself know how to contribute a patch for the fix).

@fxn
Member
fxn commented Sep 10, 2011

@jaylevitt All guides have a section about feedback at the bottom, isn't that section enough? On the other hand, docrails as such cannot have issues, docrails is only a branch, it is not a project.

@jaylevitt
Contributor

@fxn The feedback section in the guides doesn't list any place to report issues with the guides. It only gives instructions on how to patch the guides, and directs you to the mailing list for "discussions". I think it should say something like "If you found an error in these guides and don't feel confident patching it yourself, open up an issue on rails/rails."

@fxn fxn reopened this Sep 10, 2011
@fxn
Member
fxn commented Sep 10, 2011

@jaylevitt Yeah, that sounds good.

@fxn fxn closed this in a7998dc Sep 10, 2011
@heironimus heironimus pushed a commit to heironimus/rails that referenced this issue Sep 10, 2011
@fxn fxn clarify that documentation bugs have to be reported as Rails issues. …
…[Closes #2858]
e8e1911
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment