New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOC] No instructions on how to report docrails bugs #2858
Comments
docrails is up and running again: https://github.com/lifo/docrails |
@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 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). |
@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. |
@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." |
@jaylevitt Yeah, that sounds good. |
Back in April, Xavier Noria wrote:
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.
The text was updated successfully, but these errors were encountered: