From 6a338d8e0ea0c8f643e01699e014c298e34c3006 Mon Sep 17 00:00:00 2001 From: Will Kahn-Greene Date: Fri, 22 Apr 2011 22:02:55 -0400 Subject: [PATCH] Updates contributing howto * lots of changes to the contributing howto from Matt, Greg, Will, and Chris * adds references between the contributing howto and other chapters * adds a design decision regarding copyright assignment --- docs/contributinghowto.rst | 87 +++++++++++++++++++++++++++++++++++--- docs/deploymenthowto.rst | 2 + docs/designdecisions.rst | 16 +++++++ docs/index.rst | 2 +- docs/theminghowto.rst | 2 + 5 files changed, 102 insertions(+), 7 deletions(-) diff --git a/docs/contributinghowto.rst b/docs/contributinghowto.rst index 1b34badc..a44c361f 100644 --- a/docs/contributinghowto.rst +++ b/docs/contributinghowto.rst @@ -15,9 +15,21 @@ However, if you are a coder and you're looking to code, check out the The rest of this chapter talks about different things we need your help with. + +**Become a user** + + We're building GNU MediaGoblin for us and for you but really + you're one of us and I am you and we are we and GNU MediaGoblin is + the walrus. + + Sign up for an account. Use the service. Relish in the thought + that this service comes with a heaping side of Freedom and you can + salt and pepper it to your liking. + + **File bugs** - Filing bugs is an important part of any project. For more + Filing bugs is a critical part of any project. For more information on filing bugs, see :ref:`filing-bugs`. @@ -27,7 +39,50 @@ help with. multi-lingual and are interested in translating GNU MediaGoblin, see :ref:`translating`. -FIXME - add additional things here + +**Create a theme** + + As people deploy their own GNU MediaGoblin instances, good themes + are a must have! For more information on theming, see + :ref:`theming-howto`. + + +**Spread the word** + + The seductive call of Free Software services is a powerful one, + but many cannot hear it because it'd drowned out by the rush hour + traffic honking of proprietary walled gardens and faux free + services. Yuck! Be the sweet chirrup of the bird amidst the din! + Tell others that there is a better way to live! + + FIXME - do we want to talk about ways to spread the word? + + FIXME - how can people notify us that they're spreading the word? + + +**Run your own instance** + + Are there things about our instance you want to change? Are there + things about other instances you wish were different? That's + great--you can run your own instance! + + For more information on deploying your own instance, see + :ref:`deployment-howto`. + + +Contributing thank you drawings / copyright assignment +====================================================== + +Copyright assignment with GNU MediaGoblin to the `FSF +`_ is highly encouraged but not mandatory. To +incentivize both this and people to make cool contributions to our +project, if you make useful contributions to GNU MediaGoblin *and* do +a copyright assignment to the Free Software Foundation, the founder of +the project, Chris Webber, will make a custom drawing of a goblin +dedicated specifically to you. + +For why we're doing copyright assignment, see the +:ref:`design-decisions-chapter`. .. _filing-bugs: @@ -36,12 +91,30 @@ File bugs ========= GNU MediaGoblin uses a bug tracker called `Redmine -`. +`_. The bug tracker is at http://bugs.foocorp.net/ and bugs go in the ``GNU mediagoblin`` project. -FIXME - how to file a good bug report +A good bug report has the following things in it: + +1. A short summary that's 60 characters or less. + +2. A description that describes the issue (bug, feature request, ...) + as well as the context. + + * If it's a bug, can you reproduce it? Is the issue specific to a + browser, computer, image, ...? + + * If it's a feature request, are there related links on the Internet + for more information? Would you be willing to help implement or + test the feature? + +That's it! When someone looks into the issue and has questions, +they'll contact you! + +If you don't hear from anyone in a couple of weeks, find someone on +IRC. .. _translating: @@ -49,10 +122,12 @@ FIXME - how to file a good bug report Translate GNU MediaGoblin ========================= -FIXME - need to write this +Coming soon when we set up translation infrastructure. Where to go when you get stuck ============================== -FIXME - need to write this +Go to `our Web site `_ where we list the +various places we hang out and how to get a hold of us. + diff --git a/docs/deploymenthowto.rst b/docs/deploymenthowto.rst index 39cf73af..684ac1b1 100644 --- a/docs/deploymenthowto.rst +++ b/docs/deploymenthowto.rst @@ -1,3 +1,5 @@ +.. _deployment-howto: + ================== Deployment HOWTO ================== diff --git a/docs/designdecisions.rst b/docs/designdecisions.rst index 62a529ff..b48f7d80 100644 --- a/docs/designdecisions.rst +++ b/docs/designdecisions.rst @@ -237,3 +237,19 @@ everyone is the hero by Will on "Why AGPLv3 and CC0": .. _AGPL v3: http://www.gnu.org/licenses/agpl.html .. _CC0 v1: http://creativecommons.org/publicdomain/zero/1.0/ + + +Why copyright assignment? +========================= + +Will Kahn-Greene on "Why copyright assignment?": + + GNU MediaGoblin is a GNU project with the copyrights held by the + FSF. Like other GNU projects, we require copyright assignment to + the FSF which gives the FSF the legal ability to defend the + AGPL-covered status of the software and distribute it. + + This is important to us because it guarantees that this software + we're working so hard on will be available to everyone and will + survive us. As long as someone is interested in using it and/or + working on it, it will live on. diff --git a/docs/index.rst b/docs/index.rst index 98d37969..fb92d139 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,8 +13,8 @@ Table of Contents: foreward mediagoblin - deploymenthowto contributinghowto + deploymenthowto hackinghowto theminghowto softwarestack diff --git a/docs/theminghowto.rst b/docs/theminghowto.rst index 6ded4ac7..23f9cb1b 100644 --- a/docs/theminghowto.rst +++ b/docs/theminghowto.rst @@ -1,3 +1,5 @@ +.. _theming-howto: + =============== Theming HOWTO =============== -- 2.25.1