-
Notifications
You must be signed in to change notification settings - Fork 3
/
index.html
312 lines (245 loc) · 11.4 KB
/
index.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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
<!DOCTYPE html>
<html lang="en">
<head>
<title>How to contribute to Grml.org</title>
<link rel="stylesheet" href="css/bootstrap.min.css" />
<style>
body {
padding-top: 60px; /* 60px to make the container go all the way to the bottom of the topbar */
}
.page-header h2 {
padding-top: 60px;
margin-top: -60px;
}
</style>
</head>
<body>
<div class="topbar">
<div class="fill">
<div class="container">
<a class="brand" href="#">How to contribute to Grml</a>
<ul class="nav">
<li><a href="#">Home</a></li>
<li><a href="#identify">Identify</a></li>
<li><a href="#fork">Fork!</a></li>
<li><a href="#patch">Create a patch</a></li>
<li><a href="#upstream">Get your work upstream</a></li>
<li><a href="#contact">Contact</a></li>
</ul>
<p class="pull-right"><img src="img/logo.png" alt="*" /></p>
</div>
</div>
</div>
<div class="container">
<div class="content">
<div class="page-header">
<h1>How to contribute to Grml</h1>
</div>
<div class="row">
<div class="span10">
<div class="page-header">
<h2>We want you!</h2>
</div>
<p><a href="https://grml.org/">Grml</a> - the bootable Linux live system
(Live-CD) based on Debian - is an active <em>open source project</em>,
available since 2003 and used by <em>tens of thousands of
users</em>.</p>
<p><strong>We need your help!</strong> Driven by a <a
href="https://grml.org/team/">small team</a> of people in their free
time, we can't get as much stuff done as we'd like to. If Grml saved
your ass and want to give something back to the Grml project, this
website will get you started.</p>
<span class="label important">Important</span> Don't be afraid of us.
You might think that you're not experienced enough to contribute to
Grml (or any other open source project). But let us tell you otherwise:
By using Grml and arriving at this page, you are highly likely to have
a skill-set matching our needs. Early contributions tend to be small
and minor ones, but can be a first step to becoming an open source
developer. So no matter how small you may think your contribution is,
it really <em>does matter to us</em>! Don't be shy, let's make Grml
an even better kick-ass solution!
<section id="contribute">
<div class="page-header">
<h2>How to contribute to Grml.org</h2>
</div>
<p>Grml joined the Github party, all our repositories are available at
<a href="https://github.com/grml/">github.com/grml</a>. If you already
have a Github account it's really simple to contribute.</p>
<p>So, how to get started?</p>
<ul>
<li>You already have a patch? Go straight towards <a href="#upstream">
Getting your work upstream</a></li>
<li>You already have a repository and want to create a patch from it?
Check out <a href="#patch">how to create a patch</a></li>
<li>Already know which repository to work with? Skip over to <a
href="#fork">Fork!</a></li>
<li>Not sure where to find the apropriate sources? Please <a
href="#identify">read on...</a></li>
</ul>
</section>
<section id="identify"></a>
<div class="page-header">
<h2>Identifying the appropriate Git repository</h2>
</div>
<p><a href="https://github.com/grml">Soooo many Git repositories</a>,
you might ask where to start? We are here to help you!</p>
<p>Grml's project homepage is available as <a
href="https://github.com/grml/grml.org">git repository</a>. If you
found a typo, feel the desparate need to fix our <a
href="https://en.wikipedia.org/wiki/Denglisch">denglish</a>, or work on
our documentation that's the right place to start.</p>
<p>If you are also a huge fan of Zsh, Vim, Screen and Tmux and want to
pimp their configs the <a
href="https://github.com/grml/grml-etc-core.git">grml-etc-core</a>
repository is where the music plays.</p>
<p>You're already enjoying your own live system based on Grml?
Fantastic! Don't forget to check out <a
href="https://github.com/grml/grml-live">grml-live</a>.</p>
<p>Now let's visit the machine room. The boot process of Grml starts
with the Linux kernel, after that, the initramfs takes over. It's driven by
<a href="https://github.com/grml/live-boot-grml">live-boot-grml</a>.
Once the initramfs stage is finished, the main boot-up process featured
in <a href="https://github.com/grml/grml-autoconfig">grml-autoconfig</a>
takes over. live-boot-grml and grml-autoconfig are also the place where
all the nifty Grml <a href="https://grml.org/cheatcodes/">boot
options</a> are implemented at.</p>
<p>A simple frontend to set up booting via network (PXE) is known as <a
href="https://github.com/grml/grml-terminalserver">grml-terminalserver</a>.</p>
<p>To get your live system onto a USB thumb drive, <a
href="https://github.com/grml/grml2usb">grml2usb</a> is waiting for
you.</p>
<p><span class="label notice">Notice</span>: none of the described
repositories match your needs? Either go through <a
href="https://github.com/grml">the repository list</a> and try to spot the
appropriate repository or just <a href="#contact">talk to us</a>.</p>
</section>
<section id="fork"></a>
<div class="page-header">
<h2>Fork!</h2>
</div>
<p>You <a href="#identify">identified the correct Git repository</a>?
Great! The easiest way to play with the repository is by choosing the
'Fork' feature at the right side of the upper screen:</p>
<ul class="media-grid">
<li>
<a href="https://github.com/grml/grml-etc-core">
<img class="thumbnail" src="img/fork.png" alt="Screenshot of Fork button at Github" />
</a>
</li>
</ul>
<p>This should give you your own copy of the Git repository and you can
commit to it without even asking us for permission. Then you can simply
<a href="#patch">create a patch</a>.
<p>You don't have a Github account (yet)? You can grab the Git
repository anyway. On the Github web page you can click on 'Git
Read-Only'. Then clone the URL (being
'https://github.com/grml/grml-etc-core.git' in the following screenshot):</p>
<ul class="media-grid">
<li>
<a href="https://github.com/grml/grml-etc-core">
<img class="thumbnail" src="img/clone.png" alt="Screenshot of Github repository cloning" />
</a>
</li>
</ul>
<p>Check out the repository and explore it:</p>
<pre>
% git clone https://github.com/grml/grml-etc-core.git
% cd grml-etc-core</pre>
</section>
<section id="patch"></a>
<div class="page-header">
<h2>Create a patch</h2>
</div>
<p>Creating a patch is simple. Check out a new branch in your repository
(to avoid messy commit history and conflicts possibly showing up in master):</p>
<pre>
% git checkout -b mygreatfeature</pre>
<p>Implement your bugfix/feature and once you're happy about it, commit
your work (replace $FILES with the files you changed):</p>
<pre>
% [hack hack hack]
% git add $FILES
% git commit -v</pre>
<p>That's pretty much it. If you aren't familiar with Git yet and want
to learn more, <a href="https://git-scm.com/">git-scm.com</a> has plenty
of useful information.</p>
<p>Finally, it would be great if you'd share your work with us!</p>
</section>
<section id="upstream"></a>
<div class="page-header">
<h2>Get your work upstream</h2>
</div>
<p>Getting your work into Grml isn't only about making Grml even hotter.
It also has advantages for you! You get your features tested and
maintained by the community and gain credit.</p>
<p>If you chose to <a href="#fork">fork</a> the repository, all you've
got to do is click on the 'Pull Request' button on your Github page:</p>
<div class="span4">
<ul class="media-grid">
<li>
<a href="https://grml.org/screenshots/">
<img src="img/pull-request.png" alt="Screenshot of Github's pull-request button" />
</a>
</li>
</ul>
</div>
<p>If you're interested in further documentation regarding pull
requests, <a href="https://help.github.com/send-pull-requests/">head over
to the Github page about pull requests</a>.
<p>Don't have a Github account and/or prefer email? No worries.
Create a patch based on your work:</p>
<pre>
% git format-patch origin/master</pre>
<p>Then send the created patch file(s) to bugs (at) grml.org. Either use
your common mail client or, if you prefer, use Git itself:</p>
<pre>
% git send-email 000*.patch</pre>
</section>
<section id="contact"></a>
<div class="page-header">
<h2>Contact</h2>
</div>
<span class="label important">Important</span> If you're unsure about
something (like which repository is the right one, if a particular bug
is fixed already, what the best way to get started with your
awesome new feature is, or think this page is incomplete): talk to
us! We're usually available on IRC in #grml on irc.oftc.net. (most
of us are using Central European (Summer) Time). If you prefer asynchronous
communication, <a
href="https://ml.grml.org/mailman/listinfo/grml-devel">subscribe to the
grml-devel mailinglist</a> and flood our mailboxes!</p>
</section>
</div>
<div class="span4">
<ul class="media-grid">
<li>
<a href="https://grml.org/screenshots/">
<img class="thumbnail" src="img/grml_2011.12.jpg" alt="">
</a>
</li>
<li>
<a href="https://twitter.com/grmlproject" class="twitter-follow-button" data-show-count="false">Follow @grmlproject</a><script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
</li>
</ul>
</div>
</div>
</div>
<footer>
<p>© Grml Project 2012++ - <a
href="https://github.com/grml/grml.github.com">Fork this project at github</a></p>
</footer>
</div>
<!-- Piwik -->
<script type="text/javascript">
var pkBaseURL = (("https:" == document.location.protocol) ? "https://stats.grml.org/piwik/" : "https://stats.grml.org/piwik/");
document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
</script><script type="text/javascript">
try {
var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", 1);
piwikTracker.trackPageView();
piwikTracker.enableLinkTracking();
} catch( err ) {}
</script><noscript><p><img src="https://stats.grml.org/piwik/piwik.php?idsite=1" style="border:0" alt="" /></p></noscript>
<!-- End Piwik Tracking Code -->
</body>
</html>