This repository has been archived by the owner on Jan 7, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
contribute.html
217 lines (204 loc) · 13.7 KB
/
contribute.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>Ruby on Rails Guides: Contribute to the Rails Guides</title>
<link rel="stylesheet" type="text/css" href="stylesheets/style.css" />
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />
<link rel="stylesheet" type="text/css" href="stylesheets/syntaxhighlighter/shCore.css" />
<link rel="stylesheet" type="text/css" href="stylesheets/syntaxhighlighter/shThemeRailsGuides.css" />
</head>
<body class="guide">
<div id="topNav">
<div class="wrapper">
<strong>More at <a href="http://rubyonrails.org/">rubyonrails.org:</a> </strong>
<a href="http://rubyonrails.org/">Overview</a> |
<a href="http://rubyonrails.org/download">Download</a> |
<a href="http://rubyonrails.org/deploy">Deploy</a> |
<a href="http://rails.lighthouseapp.com/projects/8994-ruby-on-rails/overview">Code</a> |
<a href="http://rubyonrails.org/screencasts">Screencasts</a> |
<a href="http://rubyonrails.org/documentation">Documentation</a> |
<a href="http://rubyonrails.org/ecosystem">Ecosystem</a> |
<a href="http://rubyonrails.org/community">Community</a> |
<a href="http://weblog.rubyonrails.org/">Blog</a>
</div>
</div>
<div id="header">
<div class="wrapper clearfix">
<h1><a href="index.html" title="Return to home page">Guides.rubyonrails.org</a></h1>
<p class="hide"><a href="#mainCol">Skip navigation</a>.</p>
<ul class="nav">
<li><a href="index.html">홈</a></li>
<li class="index"><a href="index.html" onclick="guideMenu(); return false;" id="guidesMenu">목차</a>
<div id="guides" class="clearfix" style="display: none;">
<hr />
<dl class="L">
<dt>시작</dt>
<dd><a href="getting_started.html">레일즈 시작하기</a></dd>
<dt>모델(Models)</dt>
<dd><a href="migrations.html">레일즈 데이터베이스 마이그레이션</a></dd>
<dd><a href="active_record_validations_callbacks.html">액티브 레코드 데이터 검증(Validation)과 Callback(콜백)</a></dd>
<dd><a href="association_basics.html">액티브 레코드 Association(관계)</a></dd>
<dd><a href="active_record_querying.html">액티브 레코드 쿼리 인터페이스</a></dd>
<dt>뷰(Views)</dt>
<dd><a href="layouts_and_rendering.html">레이아웃(Layouts)과 렌더링(Rendering)</a></dd>
<dd><a href="form_helpers.html">액션 뷰 폼 핼퍼(Action View Form Helpers)</a></dd>
<dt>컨트롤러(Controllers)</dt>
<dd><a href="action_controller_overview.html">액션 컨트롤러 둘러보기</a></dd>
<dd><a href="routing.html">외부 요청에 대한 레일즈 라우팅</a></dd>
</dl>
<dl class="R">
<dt>심화내용</dt>
<dd><a href="active_support_core_extensions.html">액티브 서포트(Active Support) 확장(Core Extensions)</a></dd>
<dd><a href="i18n.html">레일즈 국제화I(nternationalization) API</a></dd>
<dd><a href="action_mailer_basics.html">액션 메일러의 기본</a></dd>
<dd><a href="testing.html">레일즈 어플리케이션 테스트하기</a></dd>
<dd><a href="security.html">레일즈 어플리케이션의 보안</a></dd>
<dd><a href="debugging_rails_applications.html">레일즈 어플리케이션 디버깅</a></dd>
<dd><a href="performance_testing.html">레일즈 어플리케이션 성능 테스트하기</a></dd>
<dd><a href="configuring.html">레일즈 어플리케이션 설정</a></dd>
<dd><a href="command_line.html">레일즈 커멘드라인 도구와 Rake 테스크</a></dd>
<dd><a href="caching_with_rails.html">레일즈를 이용한 캐싱</a></dd>
<dt>레일즈 확장하기(Extending Rails)</dt>
<dd><a href="plugins.html">레일즈 플러그인 작성의 기본</a></dd>
<dd><a href="rails_on_rack.html">렉 위의 레일즈(Rails on Rack)</a></dd>
<dd><a href="generators.html">레일즈 제너레이터(Generator) 제작과 수정</a></dd>
<dt>루비 온 레이즈에 기여하기</dt>
<dd><a href="contributing_to_ruby_on_rails.html">루비 온 레이즈에 기여하기</a></dd>
<dd><a href="api_documentation_guidelines.html">API 문서 가이드라인</a></dd>
<dd><a href="ruby_on_rails_guides_guidelines.html">루비 온 레일즈 가이드에 대한 가이드라인</a></dd>
<dt>Release Notes</dt>
<dd><a href="3_0_release_notes.html">Ruby on Rails 3.0 Release Notes</a></dd>
<dd><a href="2_3_release_notes.html">Ruby on Rails 2.3 Release Notes</a></dd>
<dd><a href="2_2_release_notes.html">Ruby on Rails 2.2 Release Notes</a></dd>
</dl>
</div>
</li>
<li><a href="contribute.html">기여하기</a></li>
<li><a href="credits.html">수고하신 분들</a></li>
</ul>
</div>
</div>
<hr class="hide" />
<div id="feature">
<div class="wrapper">
<h2>Contribute to the Rails Guides</h2>
<p>Rails Guides aim to improve the Rails documentation and to make the barrier to entry as low as possible. A reasonably experienced developer should be able to use the guides to come up to speed on Rails quickly. Our sponsors have contributed prizes for those who write an entire guide, but there are many other ways to contribute.</p>
<div id="subCol">
<h3 class="chapter"><img src="images/chapters_icon.gif" alt="" />Chapters</h3>
<ol class="chapters">
<li><a href="#how-to-contribute">How to Contribute?</a></li><li><a href="#what-to-contribute">What to Contribute?</a></li><li><a href="#how-is-the-process">How is the process?</a></li><li><a href="#prizes">Prizes</a></li><li><a href="#rules">Rules</a></li><li><a href="#translations">Translations</a></li><li><a href="#mailing-list">Mailing List</a></li><li><a href="#contact">Contact</a></li></ol></div>
</div>
</div>
<div id="container">
<div class="wrapper">
<div id="mainCol">
<h3 id="how-to-contribute">1 How to Contribute?</h3>
<ul>
<li>We have an open commit policy: anyone is welcome to contribute and to review contributions.</li>
<li><a href="http://github.com/lifo/docrails">docrails is hosted on GitHub</a> and has public write access.</li>
<li>Guides are written in Textile, and reside at <tt>railties/guides/source</tt> in the docrails project.</li>
<li>Follow the <a href="http://wiki.github.com/lifo/docrails/rails-guides-conventions">Rails Guides Conventions</a>.</li>
<li>Assets are stored in the <tt>railties/guides/assets</tt> directory.</li>
<li>Sample format : <a href="http://github.com/lifo/docrails/blob/3e56a3832415476fdd1cb963980d0ae390ac1ed3/railties/guides/source/association_basics.textile">Active Record Associations</a>.</li>
<li>Sample output : <a href="association_basics.html">Active Record Associations</a>.</li>
<li>You can build the Guides during testing by running <tt>bundle exec rake generate_guides</tt> in the <tt>railties</tt> directory.</li>
<li>You’re encouraged to validate <span class="caps">XHTML</span> for the generated guides before commiting your changes by running <tt>bundle exec rake validate_guides</tt> in the <tt>railties</tt> directory.</li>
<li>Edge guides <a href="http://edgeguides.rubyonrails.org/">can be consulted online</a>. That website is generated periodically from docrails.</li>
</ul>
<h3 id="what-to-contribute">2 What to Contribute?</h3>
<ul>
<li>We need authors, editors, proofreaders, and translators. Adding a single paragraph of quality content to a guide is a good way to get started.</li>
<li>The easiest way to start is by improving an existing guide:
<ul>
<li>Improve the structure to make it more coherent.</li>
<li>Add missing information.</li>
<li>Correct any factual errors.</li>
<li>Fix typos or improve style.</li>
<li>Bring it up to date with the latest Edge Rails.</li>
</ul></li>
<li>We’re also open to suggestions for entire new guides:
<ul>
<li>Contact lifo or fxn to get your idea approved. See the Contact section below.</li>
<li>If you’re the main author on a significant guide, you’re eligible for the prizes.</li>
</ul></li>
</ul>
<h3 id="how-is-the-process">3 How is the process?</h3>
<ul>
<li>The preferred way to contribute is to commit to docrails directly.</li>
<li>A new guide is only edited by its author until finished though. In that case feedback can be given in its LH ticket.</li>
<li>If you are writing a new guide freely commit to docrails partial work and ping lifo or fxn when done with a first draft.</li>
<li>Guides reviewers will then provide feedback, some of it possibly in form of direct commits to agilize the process.</li>
<li>Eventually the guide will be approved and added to the index.</li>
</ul>
<h3 id="prizes">4 Prizes</h3>
<p>For each completed guide, the lead contributor will receive all of the following prizes:</p>
<ul>
<li>$200 from Caboose Rails Documentation Project.</li>
<li>1 year of GitHub Micro account worth $84.</li>
<li>1 year of <span class="caps">RPM</span> Basic (Production performance management) for up to 10 hosts worth 12 months x $40 per host x 10 hosts = $4800. And also, savings of $45 per host per month over list price to upgrade to advanced product.</li>
</ul>
<h3 id="rules">5 Rules</h3>
<ul>
<li>Guides are licensed under a Creative Commons Attribution-Share Alike 3.0 License.</li>
<li>If you’re not sure whether a guide is actively being worked on, stop by <span class="caps">IRC</span> and ask.</li>
<li>If the same guide writer wants to write multiple guides, that’s ideally the situation we’d love to be in! However, that guide writer will only receive the cash prize for all the subsequent guides (and not the GitHub or <span class="caps">RPM</span> prizes).</li>
<li>Our review team will have the final say on whether the guide is complete and of good enough quality.</li>
</ul>
<p>All authors should read and follow the <a href="http://wiki.github.com/lifo/docrails/rails-guides-conventions">Rails Guides Conventions</a> and the <a href="http://wiki.github.com/lifo/docrails/rails-api-documentation-conventions">Rails <span class="caps">API</span> Documentation Conventions</a>.</p>
<h3 id="translations">6 Translations</h3>
<p>The translation effort for the Rails Guides is just getting underway. We know about projects to translate the Guides into Spanish, Portuguese, Polish, and French. For more details or to get involved see the <a href="http://wiki.github.com/lifo/docrails/translating-rails-guides">Translating Rails Guides</a> page.</p>
<h3 id="mailing-list">7 Mailing List</h3>
<p><a href="http://groups.google.com/group/rubyonrails-docs">Ruby on Rails: Documentation</a> is the mailing list for all the guides/documentation related discussions.</p>
<h3 id="contact">8 Contact</h3>
<ul>
<li><span class="caps">IRC</span> : #docrails channel in irc.freenode.net</li>
<li>Twitter: <a href="http://twitter.com/docrails">@docrails</a>, <a href="http://twitter.com/lifo">@lifo</a>, <a href="http://twitter.com/fxn">@fxn</a></li>
<li>Email : pratiknaik aT gmail, fxn aT hashref dot com</li>
</ul>
<h3>Feedback</h3>
<p>
You're encouraged to help in keeping the quality of this guide.
</p>
<p>
If you see any typos or factual errors you are confident to
patch, please clone <a href="https://github.com/lifo/docrails">docrails</a>
and push the change yourself. That branch of Rails has public write access.
Commits are still reviewed, but that happens after you've submitted your
contribution. <a href="https://github.com/lifo/docrails">docrails</a> is
cross-merged with master periodically.
</p>
<p>
You may also find incomplete content, or stuff that is not up to date.
Please do add any missing documentation for master. Check the
<a href="ruby_on_rails_guides_guidelines.html">Ruby on Rails Guides Guidelines</a>
for style and conventions.
</p>
<p>
Issues may also be reported in <a href="https://github.com/lifo/docrails/issues">Github</a>.
</p>
<p>And last but not least, any kind of discussion regarding Ruby on Rails
documentation is very welcome in the <a href="http://groups.google.com/group/rubyonrails-docs">rubyonrails-docs mailing list</a>.
</p>
</div>
</div>
</div>
<hr class="hide" />
<div id="footer">
<div class="wrapper">
<p>This work is licensed under a <a href="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons Attribution-Share Alike 3.0</a> License</p>
<p>"Rails", "Ruby on Rails", and the Rails logo are trademarks of David Heinemeier Hansson. All rights reserved.</p>
</div>
</div>
<script type="text/javascript" src="javascripts/guides.js"></script>
<script type="text/javascript" src="javascripts/syntaxhighlighter/shCore.js"></script>
<script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushRuby.js"></script>
<script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushXml.js"></script>
<script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushSql.js"></script>
<script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushPlain.js"></script>
<script type="text/javascript">
SyntaxHighlighter.all()
</script>
</body>
</html>