forked from collective/Collective
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
215 lines (200 loc) · 11 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
<!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: Feb 04, 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: Feb 04, 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: Feb 04, 2012"
href="_static/opensearch.xml"/>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="top" title="collective.github.com - Last updated: Feb 04, 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: Feb 04, 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="migration">
<h1>Migration<a class="headerlink" href="#migration" title="Permalink to this headline">¶</a></h1>
<p>The sync from the Plone subversion repository was done using the scripts
located here: <a class="reference external" href="https://github.com/plone/svn-migrate">https://github.com/plone/svn-migrate</a>.</p>
<p>After the initial sync, ongoing syncing is not possible. Either you move
your stuff to github or you leave it on svn/collective (or you move it to
any other location, such as bitbucket).</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>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></li>
<li>Or 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>
</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="overview">
<h2>Overview<a class="headerlink" href="#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 (We might change this in the future to read from plone.org’s LDAP,
but for now this is the place).</p>
<p>Fork the <a class="reference external" href="https://github.com/collective/collective.github.com">collective.github.com</a>
repository and then edit the <a class="reference external" href="https://github.com/collective/collective.github.com/blob/master/permissions.cfg">permissions.cfg</a>. If you’re done commit, push
and create a pull request.</p>
<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>Existing repository, but not owner any more</dt>
<dd>You created a repository in past and now youre 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>
<dt>Fork an existing repository from another github user or organization</dt>
<dd><p class="first">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>Create a new repository</dt>
<dd><p class="first">Add a new section:</p>
<div class="last highlight-python"><pre>[repo:NEW_REPOSITORY_NAME]
teams = contributors
owners = MY_USERNAME</pre>
</div>
</dd>
<dt>Add yourself to the <tt class="docutils literal"><span class="pre">contributors</span></tt> (or any other team)</dt>
<dd>Find the section <tt class="docutils literal"><span class="pre">[team:contributors]</span></tt> and append your username to the end.</dd>
</dl>
<p><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>
<p><strong>TODO:</strong> script does not set owner the person who forked project or first
committer</p>
</div>
</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: Feb 04, 2012</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010, Rok Garbas <rok@garbas.si>.
Last updated on Feb 04, 2012.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
</div>
</body>
</html>