contrib: formatting and some word smithing
authorMichael Meffie <mmeffie@sinenomine.net>
Fri, 9 May 2014 13:18:32 +0000 (09:18 -0400)
committerMichael Meffie <mmeffie@sinenomine.net>
Fri, 9 May 2014 13:18:32 +0000 (09:18 -0400)
contrib.mdwn

index ff19550..8f62606 100644 (file)
@@ -1,64 +1,53 @@
-# Community contributions
+# OpenAFS-Contrib
 
-Many people have written a lot of scripts to make daily chores easier.<br/>
-Here, we'd like to gather them, so that it is easy to look them up.
+[openafs-contrib][1] on GitHub is a place to collect projects related
+to OpenAFS. Each project under [openafs-contrib][1] has it's own
+reposistories. Each reposistory may has a team with read-write access
+to the separate projects.
 
-## code stored on github 
+This is done instead of having personal GitHub repos, or static collections of
+links to make it easier to find projects releated to OpenAFS.  We invite you to
+use [openafs-contrib][1] for your own projects so that others can reuse them or
+even improve them.
 
-Instead of having a static collection of links or source-code, we <br/>
-created a repository to github and invite you to use it for your own scripts<br/>
-so that others can reuse them or even improve them.
+## What can I do?
 
-For this, we created an organizatorial user openafs-contrib on github.com :
+Well, if you have some code to share, you could do one of the following:
 
-<https://github.com/openafs-contrib>
+1. I have some code which would fit in a repo.
 
-There, we can host different repositories for different needs.<br/>
-The idea is that each project can have its own repositories.<br/>
-To each repository, there is a team with RW access.
+ * ask for membership of a team dedicated to a repo, where your code fits,
+   so you can work directly on it.
+ * fork this repo and send pull-requests so that a member of a team can
+   integrate it
 
-So far there is :
-
- * [afspy](https://github.com/openafs-contrib/afspy) (python-bindings to afs as introduced at the EAKC 2011 https://indico.desy.de/getFile.py/access?contribId=10&sessionId=7&resId=0&materialId=slides&confId=4756)
- * [misc](https://github.com/openafs-contrib/misc) (unsorted)
-
-## What can I do ?
-
-Well, if you have some code to share, you could do one of the following :
-
-1. I have some code which would fit in a repo :
- * ask for membership of a team dedicated to a repo, where your code fits, so you can work directly on it.
- * fork this repo and send pull-requests so that a member of a team can integrate it
 2. I have some code which would need its own repo
+
  * ask openafs-contrib to setup a repo and team for you
 
 3. I have no clue about git and don't want to learn it.
- * This is sad, but alas, just send the code to one of the openafs-contrib maintainers and they'll 
-   act as a proxy (hopefully until you learned git).
 
+ * This is sad, but alas, just send the code to one of the openafs-contrib
+   maintainers and they'll act as a proxy (hopefully until you learned git).
 
 ## Communication
 
-We should communicate through a mailing-list, but this has to be setup.
-
-If you have something you like to share, please
-contact any of the four members of the openafs-contrib-team :
+If you have something you like to share, please contact any of the four members
+of the openafs-contrib-team:
 
-* Jakob Haufe  (sur5r)
-* Michael Meffie (mmeffie)
-* Fabrizio Manfredi (thoulen)
-* Christof Hanke (chanke)
+  * Jakob Haufe (sur5r)
+  * Michael Meffie (mmeffie)
+  * Fabrizio Manfredi (thoulen)
+  * Christof Hanke (chanke)
 
-
-## first steps
+## First steps
 
 Unlike openafs.org, openafs-contrib is not using gerrit, but git directly.
 Still, many of the documentation at [[GitDevelopers]] still applies.
 
 However, here things are a bit different:
 
-As an example this is what I would do when working for afspy :
+As an example this is what I would do when working for afspy:
 
 1. create your user (here chanke) at github.
 2. Fork the repository (inside github), you want to contribute to.
@@ -68,12 +57,8 @@ As an example this is what I would do when working for afspy :
 6. Send a pull request towards openafs-contrib.
 
 Of course, when member of a team which owns a repository, you could push
-to that directly, but it is good practice to first commit stuff to your 
+to that directly, but it is good practice to first commit stuff to your
 private repo and then request the pull from openafs-contrib.
 
 
-## To-do :
-
-* setup mailing list
-* setup email-notifications
-* make this page more better
+[1]: https://github.com/openafs-contrib