Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Merge pull request #43 from mzdaniel/docs

Add more documents from the wiki
  • Loading branch information...
commit e673c6863758c3d1f9829d6d981aeb30a455087d 2 parents faf38f4 + ace5fd7
paulproteus authored June 26, 2012
40  docs/contributor/chat_on_irc.rst
Source Rendered
... ...
@@ -0,0 +1,40 @@
  1
+===================
  2
+Chat with us on IRC
  3
+===================
  4
+
  5
+You can usually find us on #openhatch on irc.freenode.net
  6
+
  7
+If you don't know how to use IRC, you can just click on `this link to a web
  8
+chat interface <http://webchat.freenode.net/?channels=#openhatch>`_.
  9
+
  10
+Are you trying to figure out who everybody is? Many of the people are part of
  11
+the `OpenHatch project <http://openhatch.org/+projects/OpenHatch>`_.
  12
+
  13
+
  14
+Quick start
  15
+===========
  16
+
  17
+::
  18
+
  19
+    /server irc.freenode.net
  20
+
  21
+    /join #openhatch
  22
+
  23
+    /nick newnickname
  24
+
  25
+    /me waves hello
  26
+
  27
+    # The /me is an action message.
  28
+    # Type /me 'does anything'
  29
+    # Example:  /me waves hello
  30
+    # What it looks like: * bossmom waves hello
  31
+
  32
+
  33
+More details: http://www.ircbeginner.com/ircinfo/ircc-commands.html
  34
+
  35
+
  36
+See also
  37
+========
  38
+
  39
+`Getting started - laptop setup <https://openhatch.org/wiki/Open_Source_Comes_to_Campus/UMD/Laptop_setup>`_
  40
+
14  docs/contributor/index.rst
Source Rendered
@@ -5,13 +5,13 @@ Contributor process
5 5
 * Code style
6 6
 
7 7
 .. toctree::
8  
-    :maxdepth: 2
  8
+  :maxdepth: 2
9 9
 
10  
-    about_our_community
11  
-    getting_started
12  
-    handling_patches
13  
-    login_team
14  
-    login_team_agreement
  10
+  about_our_community
  11
+  chat_on_irc
  12
+  getting_started
  13
+  handling_patches
  14
+  login_team
  15
+  login_team_agreement
15 16
 
16  
-* Chat with us on IRC
17 17
 * Merging patches
49  docs/internals/backup.rst
Source Rendered
... ...
@@ -0,0 +1,49 @@
  1
+========================
  2
+Backups of the live site
  3
+========================
  4
+
  5
+
  6
+Overview
  7
+========
  8
+
  9
+We have a free, donated account from rsync.net that lets us store 50GB of data
  10
+there.
  11
+
  12
+We use duplicity (as per the rsync.net `official document`_). We do full backups
  13
+weekly and incrementals daily. We encrypt these backups.
  14
+
  15
+The only server essential to continued operation of the site is
  16
+linode.openhatch.org. The other servers do unimportant things that do not keep
  17
+state. It would be convenient to have backups for them, but it is not
  18
+essential, so for now I suggest we simply skip it.
  19
+
  20
+.. _official document: http://www.rsync.net/resources/howto/duplicity.html
  21
+
  22
+
  23
+Details
  24
+=======
  25
+
  26
+We use this script to run backups. It runs via root's crontab, and emails the
  27
+results to Asheesh daily.
  28
+
  29
+* do_backup.sh: `in git`_
  30
+
  31
+.. _in git: https://github.com/openhatch/oh-restore/blob/master/do_backup.sh
  32
+
  33
+
  34
+Restoring
  35
+=========
  36
+
  37
+duplicity has a built-in "verify" feature, which checksums the data, but that
  38
+doesn't help us ensure that our backup was complete.
  39
+
  40
+Therefore, weekly, we automatically restore and test the virtual machine, via a
  41
+Jenkins job. http://openhatch.org/bugs/issue530 describes that.
  42
+
  43
+
  44
+More info about encryption
  45
+==========================
  46
+
  47
+This backup is encrypted with a GPG key that has been emailed to hello
  48
+@openhatch.org on Thu, Jan 26.
  49
+
51  docs/internals/bug_tracker_architecture.rst
Source Rendered
... ...
@@ -0,0 +1,51 @@
  1
+====================================
  2
+Bug tracker import code/architecture
  3
+====================================
  4
+
  5
+
  6
+About this page
  7
+===============
  8
+
  9
+This page covers the **architecture** of our bug tracker import code. There are
  10
+other wiki pages covering the :doc:`/internals/index` and our bug tracker
  11
+import code.
  12
+
  13
+
  14
+One file per style of bug tracker
  15
+=================================
  16
+
  17
+Each *style* (like "Bugzilla", "Roundup", and so forth) of bug tracker has its
  18
+code in mysite/customs/bugtrackers/*style*.py. We write tests in
  19
+mysite/customs/tests.py for each bug tracker type.
  20
+
  21
+The Roundup code is instructive. Look at that in your favorite editor. You'll
  22
+see *class RoundupTracker*. Take a look -- the class's __init__() is built so
  23
+that an instance has enough data that a call to grab() will start downloading
  24
+bug data.
  25
+
  26
+The rest of that file is trivial subclasses that pre-fill the data to
  27
+__init__(). We have one subclass per bug tracker we pull data from.
  28
+
  29
+
  30
+Then, once a day
  31
+================
  32
+
  33
+We have a cron job on the server that calls the code in
  34
+*mysite/customs/management/commands/customs_daily_tasks.py* every night.
  35
+
  36
+
  37
+How to add a new bug tracker
  38
+============================
  39
+
  40
+That means that if you want to add code pull data from a bug tracker we already
  41
+support, you just have to write a very simple subclass. For Roundup, for
  42
+example, add a few lines to the end of mysite/customs/bugtrackers/roundup.py.
  43
+Then submit a patch.
  44
+
  45
+If you want to write support for an entirely new type of bug tracker, you'll
  46
+have to write a new class. Before we merge it, we'll need some tests, but we
  47
+can help you write the tests. Submit your patches as you go, and we can
  48
+review/merge quickly!
  49
+
  50
+(Wondering how to submit a patch? Read :doc:`/contributor/handling_patches`.)
  51
+
20  docs/internals/index.rst
Source Rendered
@@ -7,8 +7,20 @@ Internals
7 7
 * Automated testing
8 8
 
9 9
 .. toctree::
10  
-    :maxdepth: 2
  10
+  :maxdepth: 2
11 11
 
12  
-    monitoring
13  
-    continuous_integration
14  
-    emergency_operations
  12
+  monitoring
  13
+  continuous_integration
  14
+  backup
  15
+  emergency_operations
  16
+
  17
+
  18
+Bug tracker import code
  19
+=======================
  20
+
  21
+.. toctree::
  22
+  :maxdepth: 2
  23
+
  24
+  bug_tracker_architecture
  25
+
  26
+* a step-by-step guide on adding a bug tracker

0 notes on commit e673c68

Please sign in to comment.
Something went wrong with that request. Please try again.