forked from collective/Collective
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
251 lines (236 loc) · 13.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Introduction — collective.github.com - Last updated: Aug 08, 2012</title>
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: 'Last updated: Aug 08, 2012',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within collective.github.com - Last updated: Aug 08, 2012"
href="_static/opensearch.xml"/>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="top" title="collective.github.com - Last updated: Aug 08, 2012" href="#" />
<link rel="next" title="How to follow commits" href="how_to_followcommits.html" />
<script src="_static/jquery.min.js" type="text/javascript"></script>
<script src="_static/jquery.zrssfeed.min.js" type="text/javascript"></script>
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="how_to_followcommits.html" title="How to follow commits"
accesskey="N">next</a> |</li>
<li><a href="#">collective.github.com - Last updated: Aug 08, 2012</a> »</li>
</ul>
</div>
<div class="document">
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="#">
<img class="logo" src="_static/logo.png" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="how_to_followcommits.html">How to follow commits</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to_update_this_documentation.html">How to update this page</a></li>
<li class="toctree-l1"><a class="reference internal" href="new_to_git.html">New to git?</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to_merge.html">How to merge pull requests (Admin documentation)</a></li>
</ul>
</div>
</div>
<script type="text/javascript">
$(document).ready(function () {
$('#zrssfeed-collective').rssfeed('https://github.com/collective.atom', {
limit: 5
});
});
</script>
<div id="zrssfeed-collective"></div>
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="introduction">
<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1>
<p><a class="reference external" href="http://github.com/collective">github/collective</a> started as an experiment in October 2010. Many
<a class="reference external" href="http://plone.org">Plone</a> developers have joined since then, which
definitely shows that development using git is gaining popularity amongst Plonistas.</p>
</div>
<div class="section" id="rules-on-github-collective">
<h1>“Rules” on github/collective<a class="headerlink" href="#rules-on-github-collective" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li>Every member gets Github’s <tt class="docutils literal"><span class="pre">Pull</span> <span class="pre">and</span> <span class="pre">Push</span></tt> permission to all repositories.</li>
<li>Each repository has owners (team of repository owners) which have
Administrative rights to it.</li>
<li>Abuse should be reported by opening a ticket in the <a class="reference external" href="https://github.com/collective/collective.github.com">collective.github.com</a> repository.</li>
</ul>
</div>
<div class="section" id="how-to-get-access">
<h1>How to get access<a class="headerlink" href="#how-to-get-access" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li>Fork <a class="reference external" href="https://github.com/collective/collective.github.com">collective.github.com</a> repository, edit <tt class="docutils literal"><span class="pre">permissions.cfg</span></tt> file,
commit and push it and send us a Pull Request (see section below for details).</li>
<li>File a ticket that you want permission here:
<a class="reference external" href="https://github.com/collective/collective.github.com/issues">https://github.com/collective/collective.github.com/issues</a>
(may take longer to process than forking, because a human needs to work more here)</li>
</ul>
</div>
<div class="section" id="how-to-manage-permissions-and-repositories">
<h1>How to manage permissions and repositories<a class="headerlink" href="#how-to-manage-permissions-and-repositories" title="Permalink to this headline">¶</a></h1>
<div class="section" id="process-overview">
<h2>Process Overview<a class="headerlink" href="#process-overview" title="Permalink to this headline">¶</a></h2>
<p>Permissions are stored in <a class="reference external" href="https://github.com/collective/collective.github.com/blob/master/permissions.cfg">permissions.cfg</a> file in <a class="reference external" href="https://github.com/collective/collective.github.com">collective.github.com</a>
repository.</p>
<ol class="arabic simple">
<li><strong>Fork</strong> the <a class="reference external" href="https://github.com/collective/collective.github.com">collective.github.com</a>
repository to your account and then</li>
<li><strong>edit</strong> the <a class="reference external" href="https://github.com/collective/collective.github.com/blob/master/permissions.cfg">permissions.cfg</a>. If you’re done</li>
<li><strong>commit, push</strong> and create a <strong>pull request</strong>.</li>
</ol>
<p>We scheduled a script that runs every 10min and checks for differences and
updates them.</p>
<p>Inside <a class="reference external" href="https://github.com/collective/collective.github.com/blob/master/permissions.cfg">permissions.cfg</a> file you have a list of teams and repositories.
Team are sections starting with <tt class="docutils literal"><span class="pre">team:</span></tt> and repository is a section
starting with <tt class="docutils literal"><span class="pre">repo:</span></tt>.</p>
</div>
<div class="section" id="instructions-on-editing-permissions-cfg">
<h2>Instructions on editing permissions.cfg<a class="headerlink" href="#instructions-on-editing-permissions-cfg" title="Permalink to this headline">¶</a></h2>
<dl class="docutils">
<dt>Push access</dt>
<dd><p class="first">Add yourself to the <tt class="docutils literal"><span class="pre">contributors</span></tt> (or any other team)
Find the section <tt class="docutils literal"><span class="pre">[team:contributors]</span></tt> and insert your github username in
alphabetical order.</p>
<p class="last"><strong>Please not use the button on github website to create new repositories,
otherwise the admin team has to edit the permissions.cfg file manually because
of your laziness</strong></p>
</dd>
<dt>Create a new repository</dt>
<dd><p class="first">Add a new section in alphabetical order:</p>
<div class="last highlight-python"><pre>[repo:NEW_REPOSITORY_NAME]
teams = contributors
owners = MY_USERNAME</pre>
</div>
</dd>
<dt>Fork an existing repository</dt>
<dd><p class="first">In order to fork from another github user or organization add a new section:</p>
<div class="last highlight-python"><pre>[repo:REPOSITORYNAME]
fork = FROM_USERNAME_OR_ORGANISATIONNAME/REPOSITORYNAME
teams = contributors
owners = MY_USERNAME</pre>
</div>
</dd>
<dt>Not owner anymore?</dt>
<dd>You created a repository in past and now you are not owner anymore? Add
yourself to the <tt class="docutils literal"><span class="pre">owners</span> <span class="pre">=</span></tt> of the existing repository section.</dd>
</dl>
<p><strong>TODO:</strong> script does not set owner the person who forked project or first
committer</p>
</div>
</div>
<div class="section" id="how-to-migrate-a-repository-from-svn-plone-org">
<h1>How to migrate a repository from svn.plone.org<a class="headerlink" href="#how-to-migrate-a-repository-from-svn-plone-org" title="Permalink to this headline">¶</a></h1>
<p>Code in the <a class="reference external" href="http://svn.plone.org/svn/collective">Plone Collective Subversion</a>
or in the <a class="reference external" href="http://svn.plone.org/svn/archetypes">Plone Archetypes Subversion</a>
should be migrated to the Github collective if it is still used and development
happens.</p>
<p>If youre not the maintainer of the repository contact the current maintainer before.
If unsure ask at the plone-product-developers mailing-list.</p>
<p>Follow the steps below for migration.</p>
<ol class="arabic">
<li><p class="first">Add the project as a new repository to github collective <a class="reference external" href="#instructions-on-editing-permissions-cfg">as you would do for a
new one</a>. Once the pull-request was
accepted and the repository created go on with step two.</p>
</li>
<li><p class="first">On your machine use <a class="reference external" href="https://help.github.com/articles/importing-from-subversion">svn2git to migrate on your local machine</a>
(follow also the links in there). Unfortunately Plone Administrators can not provide
an authors file (mapping from user-names to e-mail addresses) for privacy reasons.</p>
</li>
<li><p class="first">rename the trunk of the existing repository to OLD-trunk and place a
MOVED-TO-GITHUB.txt at top level of the project in svn. Add a line with the url
to the repository to the file. If you do not want to checkout the
complete subversion with all the tags and branches, you can create
this file and then use the svn import command:</p>
<div class="highlight-python"><pre>svn import MOVED-TO-GITHUB.txt https://svn.plone.org/svn/collective/your.package/MOVED-TO-GITHUB.txt</pre>
</div>
</li>
<li><p class="first">Some housekeeping</p>
<ul class="simple">
<li>Rename <tt class="docutils literal"><span class="pre">README.txt</span></tt> to <tt class="docutils literal"><span class="pre">README.rst</span></tt>, update <tt class="docutils literal"><span class="pre">setup.py</span></tt> to reflect this change,</li>
<li>Update links in <tt class="docutils literal"><span class="pre">README.rst</span></tt> to point to Github project</li>
<li>Update links on <a class="reference external" href="http://plone.org/products">plone.org product page</a> to point to Github repository</li>
<li>optional: send a mail to the plone-product-developers mailing-list and
additional/optional tweet about it, write a line at IRC, if worth write a
blog post, ... to notify the community about it.</li>
</ul>
</li>
</ol>
</div>
<div class="section" id="more-information">
<h1>More information<a class="headerlink" href="#more-information" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="how_to_followcommits.html">How to follow commits</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to_update_this_documentation.html">How to update this page</a></li>
<li class="toctree-l1"><a class="reference internal" href="new_to_git.html">New to git?</a><ul>
<li class="toctree-l2"><a class="reference internal" href="new_to_git.html#useful-links">Useful links</a></li>
<li class="toctree-l2"><a class="reference internal" href="new_to_git.html#quick-guide">Quick guide</a></li>
<li class="toctree-l2"><a class="reference internal" href="new_to_git.html#some-more-useful-resources">Some more useful resources</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="how_to_merge.html">How to merge pull requests (Admin documentation)</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="how_to_followcommits.html" title="How to follow commits"
>next</a> |</li>
<li><a href="#">collective.github.com - Last updated: Aug 08, 2012</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010, Rok Garbas <[email protected]>.
Last updated on Aug 08, 2012.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>