Commit 476be88f authored by Erik Huelsmann's avatar Erik Huelsmann
Browse files

Update content/project-intro.html

parent b53da984
Pipeline #1393 passed with stage
in 3 seconds
......@@ -28,83 +28,83 @@ title: Project Hosting
<p>Hosted projects get web space, mailing lists, and disk space
for a version control system. We offer git through
<a href="https://gitlab.common-lisp.net/explore/projects/">GitLab</a>
and Subversion, augmented with Trac. Older projects may be using
different version control systems, but those services have been
deprecated -- new projects should use Git or Subversion and old
projects will be migrated in the course of 2015.
and Subversion, augmented with Trac.
</p>
<p id="project-pages">Projects using GitLab for their version control, can take advantage of
<a href="https://docs.gitlab.com/ee/user/project/pages/">GitLab Pages</a>
to host their project site. An example of such a project is the <a
href="https://gitlab.common-lisp.net/boston-lisp/boston-lisp-site/">Boston Lisp
site repository</a>; see the <a
href="https://gitlab.common-lisp.net/boston-lisp/boston-lisp-site/-/blob/master/.gitlab-ci.yml">.gitlab-ci.yml</a>
in that project for an example.
</p>
<h2>Requesting access to an existing project</h2>
<p>If you want to join an existing project, please contact the
project owners through the project mailing list (usually
&lt;project&gt;-devel@common-lisp.net). One of the project
members will contact the site admins to ask a user to be added
to their project.</p>
&lt;project&gt;-devel@common-lisp.net). Project owners can add
new members to GitLab projects themselves. For Subversion projects,
one of the project members will contact the site admins to ask the
user to be added to their project.</p>
<p>If the project is orphaned, or has no mailing list, please
contact admin@common-lisp.net directly.</p>
<p>Please note that anonymous access is available for
public Git repositories through https -- repositories can be downloaded
without requesting access!</p>
<h2>Your common-lisp.net account</h2>
<p>In order to access project resources, you'll be assigned an
account on the common-lisp.net system.</p>
<p>An e-mail alias will be set up for you as
&gt;user-name&lt;@common-lisp.net. The account will forward mail
to an account of your choice. If you want to change the address
to which the alias forwards, please change the mail address in
the .forward file in your home directory.</p>
<p>The machine doesn't allow password-based logins. To access
the machine, you need an SSH public key, which will be stored
in the file .ssh/authorized_keys in your home directory.</p>
<h2 id="your-access">Your common-lisp.net access</h2>
<p>To create a new Git project, a GitLab account can be created; please
notify admin@common-lisp.net about your intent to create projects.
Due to SPAM, you need to be granted this permission manually.
</p>
<p>To join existing Git projects, a GitLab account can be created; with
that account, access to the existing project can be requested through
the GitLab interface. Project owners will be notified of your request
for access.
</p>
<p>For Subversion access, a different account is required. An account for
Subversion access can be requested through admin@common-lisp.net by
sending an SSH public key. See <a
href="https://www.cyberciti.biz/faq/how-to-set-up-ssh-keys-on-linux-unix/">the
instructions by Cyberciti</a> how to set up SSH keys.</a>
</p>
<p>There are no limits placed on how much space you can use but
please exercise care; you will be sharing this system with
others. No CPU/RAM intensive tasks are to be performed on the
server. You have shell access but don't use it unless you
need to perform administrative tasks on your project(s).</p>
<p>There are no hard limits on resource-use. Please exercise care; you will be
sharing this system with others and stick to these basic rules:</p>
<ul>
<li>No CPU/RAM intensive tasks</li>
<li>No long-running tasks (no chat clients, <code>screen</code> sessions, etc.)</li>
<li>Don't use your shell access unless you need to perform administrative tasks on your project(s)</li>
<li>Only store publicly hosted data on the machine</li>
<li>To host video or other large assets, please contact admins</li>
<li>To run cron jobs, please consult with the admins</li>
<li>Mirrorring of resources on common-lisp.net can be arranged by consulting with admins</li>
</ul>
<p>Please note that the above also means 'no long running
processes' - e.g. no running irc or xmpp clients.</p>
<h2 id="creproj">Creating a project</h2>
<p>If you want to run a mirror of some resource on common-lisp.net,
please contact the administrators to set up the mirroring as a
system service and monitoring thereof. Please do not use your
a cron job with your own user without consulting the admins.</p>
<p>Users can create Git projects (up to 10) themselves through the GitLab interface
in their own namespace. GitLab groups (separate namespaces) can be requested through
an e-mail to admin@common-lisp.net. GitLab groups allow hosting a project site per
group.
</p>
<p>To request a Subversion project, please contact admin@common-lisp.net. If you don't have
an account yet, please see the procedure under <a href="#your-access">Your common-lisp.net
access</a> above.
</p>
<h2 id="creproj">Creating a project</h2>
<p>As a first step, please take some time to set up a simple web-page for your
project. For GitLab based projects, this can be set up as described in the section
<a href="#project-pages">What you get</a> above. Subversion-based projects can
upload it to our server (via <tt>scp</tt>). See also our section titled
&quot;<a href="#website">Website</a>&quot;.</p>
<p>Send an email to
<tt>admin&nbsp;(at)&nbsp;common-lisp&nbsp;(dot)&nbsp;net</tt>
with details about your project (your full name, your gpg public
key, description of project, any members (and their full names),
name of project and what license the code is released under). Hosting
decisions are made on case-by-case basis.</p>
<p>As a first step, please take some time to add a simple
web-page for your project. The quickest alternative edit
the HTML for our
<a href="/project/clo/sp/index.html">sample project</a>. After
editing it
to fit your project, you can upload it to our server (via
<tt>scp</tt>). See also our section titled &quot;<a
href="#website">Website</a>&quot;.</p>
<h2 id="git">Git repository access</h2>
<p>Git repositories are <a
href="https://gitlab.common-lisp.net/explore/projects">managed
using GitLab</a>. When your account
gets created, a GitLab account will be created as well. Your
GitLab account will be assigned to the GitLab groups you're
a member of.</p>
<p>Using your GitLab account, you can create Git repositories
for your project. Anonymous git access is available for
public repositories through https.</p>
<p>Your commit mails are not automatically replicated to your
commit mailing list (&lt;project-name&gt;-cvs@common-lisp.net).
It's easy to set up though. Simply go through the following steps:</p>
<p>To send e-mails on push to your project mailing list, follow these steps:</p>
<ol>
<li>Go to the project's landing page (not the group's), e.g.
SLIME's: <a href="https://gitlab.common-lisp.net/slime/slime"
......@@ -125,34 +125,20 @@ title: Project Hosting
commits to it will be sent to
<tt>&lt;project-name&gt;-cvs@common-lisp.net</tt>.</p>
<p>Anonymous read-only Subversion access is enabled by default.</p>
<h2 id="repos">Repositories over the web</h2>
<p>CVS and Subversion repositories are <a href="/viewrep/">viewable over the
web</a> by default as long as you don't change the default
configuration. For darcs you have to create your repositories
in /project/&lt;project>/public_html/darcs/ and a nightly
cronjob will pick them up and add them to the darcsweb config
file.
<p>Anonymous read-only Subversion access is enabled by default.
Repositories can be accessed through <a
href="https://svn.common-lisp.net/">https://svn.common-lisp.net/&lt;project&gt;</a>
</p>
<h2 id="website">Website</h2>
<p><tt>/project/&lt;project-name&gt;/public_html</tt> is symlinked to
from our webserver hierarchy and any files you put there will be available
by pointing your webbrowser to
<tt>http://common-lisp.net/project/&lt;project-name&gt;</tt></p>
<h2 id="website">Website</h2>
<p>We would like to ask you to put up a minimal webpage as soon
as possible (an empty directory does not say much about your
project). The quickest way is to edit the HTML of our <a
href="/project/clo/sp/index.html">sample project</a> page.</p>
<p>When the project doesn't use GitLab Pages as described above,
<tt>/project/&lt;project-name&gt;/public_html</tt> is published
from our webservers as <tt>http://common-lisp.net/project/&lt;project-name&gt;</tt></p>
<p>
Apache <a
href="http://httpd.apache.org/docs/howto/ssi.html">Server-Side
Apache <a href="http://httpd.apache.org/docs/howto/ssi.html">Server-Side
Includes</a> are enabled.
</p>
......@@ -160,33 +146,14 @@ title: Project Hosting
<h2 id="mailinglist">Automatic and manual mailinglists</h2>
<p>When your project is set up, three mailinglists are created (if you'd
rather use NNTP you can subscribe <a href="http://gmane.org">Gmane</a> to your list):</p>
<ul>
<li><tt>&lt;project-name&gt;-devel</tt></li>
<li><tt>&lt;project-name&gt;-announce</tt></li>
<li><tt>&lt;project-name&gt;-cvs</tt></li>
</ul>
<p>You, the owner, are subscribed to all of these mailinglists
by default. Any members added later will have to subscribe to
the ones they want on their own, via the Mailman interface
at:</p>
<ul>
<li><tt>http://mailman.common-lisp.net/cgi-bin/mailman/listinfo/&lt;project-name&gt;-devel</tt></li>
<li><tt>http://mailman.common-lisp.net/cgi-bin/mailman/listinfo/&lt;project-name&gt;-announce</tt></li>
<li><tt>http://mailman.common-lisp.net/cgi-bin/mailman/listinfo/&lt;project-name&gt;-cvs</tt></li>
</ul>
<p>When your project is set up, one mailinglist (&lt;project-name&gt;-devel@common-lisp.net)
is created. The project requestor is subscribed on initialization. Any future project members
will have to subscribe on their own, via the Mailman interface
at <tt>http://mailman.common-lisp.net/cgi-bin/mailman/listinfo/&lt;project-name&gt;-devel</tt>.
</p>
<p>Additional mailing lists available on request.</p>
<p>To stay up-to-date with all releases that are announced on the various
mailinglists you simply need to be subscribed to <a href="http://mailman.common-lisp.net/cgi-bin/mailman/listinfo/announcements">the
announcements mailinglist</a> as this mailinglist is in turn subscribed to all
<tt>&lt;project-name&gt;-announce</tt> lists.</p>
<h2 id="admin">Administrative requests</h2>
......@@ -196,38 +163,19 @@ title: Project Hosting
with all the relevant details (project name, etc).</p>
<h2 id="members">List of project members</h2>
<p>Every night a cronjob runs which generates a list of users who
have write access to your repositories and files. This list is
placed in <code>/var/www/pprinted-project-members/&lt;project&gt;</code>.
You may use Apache SSI to include this list on your project's
web page, ie <code>&lt;!--#include virtual="../../pprinted-project-members/&lt;project&gt;" --&gt;</code></p>
<h2 id="restore">Restoring from backup</h2>
<p>All the data is backed up regularly both on- and off-site, to cover for scenarios of user-accident as well as disaster recovery. There is,
however, no provision for user-driven recovery. Please be
careful before deleting anything on your server.</p>
<h2 id="nagging">Auto-nagging</h2>
<p>We have cronjobs which look for broken links, to see if you have
changed from the default webpage, etc. If they detect any problems
they will nag you about it every week until you fix the problem. To
which email address are these nags sent? By default, <code>&lt;project-name&gt;-devel@common-lisp.net</code>
however you can change this by creating a file named <code>/project/&lt;project-name&gt;/owner-email-address</code> and putting whatever email address you want in there. Only put your email address there or someone who
has given you permission to do so; if you misuse this your project's approval is rescinded.</p>
<p>All the data is backed up regularly both on- and off-site, to cover for scenarios
of user-accident as well as disaster recovery. There is, however, no provision for
user-driven recovery. Please be careful before deleting anything in your project.</p>
<h2 id="trac">Trac</h2>
<p>We offer a Trac instance for projects who would like one. Please specify
if want one when you set up your project or email <code>admin (at) common-lisp (dot) net</code>
to request it for an existing project.
<p>We offer a Trac instances for projects to use with their Subversion repository.
Please specify if want one when you set up your project or email <code>admin (at)
common-lisp (dot) net</code> to request it for an existing project.</p>
<p>To learn more about how Trac works at common-lisp.net, please read
<p>To learn more about how Trac works at common-lisp.net, please read
our <a href="/tools/#trac">Trac @ clnet introduction</a> .
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment