Main Page: Difference between revisions
No edit summary |
(overhaul of the front page to be more contributor-oriented per previous conversations) |
||
Line 1: | Line 1: | ||
= Want to Join the MediaGoblin Community? = |
|||
GNU MediaGoblin wiki of bizarre and unusual things |
|||
We’re really glad that you want to join the MediaGoblin community! |
|||
The MediaGobilin documentation is <strike>somewhat</strike> always in a state of transition. In the future, documentation about the software, its functioning, and its use/administration, will be in the manual at [http://docs.mediagoblin.org/ http://docs.mediagoblin.org/]. At the same time, documentation for contributors that relates to project organization, community participation, and forward looking project planning will be here on the wiki. In the meanwhile, it's a mess. |
|||
There are a variety of ways to help and support MediaGoblin and to join the team. If you want to code, great, if not, even better! MediaGoblin interested contributors in many different roles: users, system administrators, technical writers, testers, evangelists, UI/UX and graphics designers, cheerleaders, and dreamers. |
|||
= Want to contribute to GNU MediaGoblin? = |
|||
This section provides the magical incantations to help you start contributing. |
|||
This wiki covers a variety of ways that you can get involved with MediaGoblin as well as instructions on how to get started. |
|||
* '''[[Development quick start]]''' - Get MediaGoblin running on your own machine |
|||
* '''[http://docs.mediagoblin.org/contributinghowto.html Contributor HOWTO]''' - Want to start contributing to MediaGoblin? General tips are available here. |
|||
* '''[[Documentation quick start]]''' - How to contribute to the documentation effort. |
|||
== Hacking MediaGoblin == |
|||
== Hang out with the MediaGoblin folk == |
|||
* [[HackingHowto|Hacking]] - Making code contributions to MediaGoblin. |
|||
** [[BeginnersCorner|Beginner's Corner]] - Resources for those who are new to Python, MongoDB, or Git. |
|||
MediaGoblin has a mailing list and an IRC channel where we hang out. See [http://mediagoblin.org/join/ our join page] for links. |
|||
Please drop by and say “Hi!” And, if you’re looking for something to do, just ask---there’s always work to be done. |
|||
== File Bugs / Triage Bugs == |
|||
Issue reports are critical for all projects. Identified bugs give developers a basis for beginning work, and providing an idea of what features and issues are most important to users and the overall usability of the software. If you identify errors, flaws, unexpected behaviors, or deficits that impede use, file a bug. |
|||
* [[File Bugs]] -- notes on filing new bugs/issues/feature requests |
|||
* [[Triage Bugs]] -- notes on triaging |
|||
== Write Code / Fix Code == |
|||
If you are a coder and you would like to write code, the repository is hosted on gitorious. Clone or fork the repository and start poking around. Become familiar with this manual for an overview of how the software works and is used. Consider the contributor wiki for more information about the project, our preferred methods, and guides for developing MediaGoblin. We even have tips on becoming a coder and we’re willing to help! |
|||
* [[Development quick start]] - get MediaGoblin running on your own machine so you can hack on it |
|||
* [[HackingHowto|Hacking]] - notes on making and sending in code contributions |
|||
** [[BeginnersCorner|Beginner's Corner]] - resources for those who are new to Python, MongoDB, or Git. |
|||
** We'll be adding some distribution/OS specific hacking guides as separate pages soon. |
** We'll be adding some distribution/OS specific hacking guides as separate pages soon. |
||
* [[Git workflow]] - How to go about submitting patches via git. |
* [[Git workflow]] - How to go about submitting patches via git. |
||
* [[Templating]] - How our templating structure is set up |
* [[Templating]] - How our templating structure is set up |
||
== Documentation and Translations == |
|||
== Send Encouragement / Spread the Word == |
|||
Sometimes, a nice word, simple encouragement, and interest in the work we’re doing is enough to inspire a tizzy of productive work. Just a bit more interest and encouragement can even make the difference between a complete feature and limited functionality; between a completed milestone and lost momentum. |
|||
Similarly, MediaGoblin, and the movement for free network services, is always in need of encouragement. Use free network services, understand the principals behind the movement, be able to articulate the benefits of free network services and the problems with psudo-free applications that don’t respect the users’ freedom. |
|||
Write a blog post, post a status update, drop by the listserv or join #mediagoblin on freenode.net and let us know. See [http://mediagoblin.org/join/ our join page] for links. |
|||
== Write Documentation / Edit Documentation == |
|||
* [[Documentation quick start]] - How to contribute to the documentation effort. |
|||
* [[ManualStandards]] - covers the standards for writing the user manual (forthcoming.) |
* [[ManualStandards]] - covers the standards for writing the user manual (forthcoming.) |
||
== Test MediaGoblin == |
|||
* [[UnitTests|Unit Tests]] - all about the unit tests |
|||
* [[User Experience]] - user experience testing. Includes link to an instance you can try! |
|||
== Translate MediaGoblin == |
|||
If you know English and another language and feel comfortable translating elements of the interface or even the documentation, we’d love to have help translating the software and resources. |
|||
* [[Translations]] - How to translate stuff or update the translations |
* [[Translations]] - How to translate stuff or update the translations |
||
== Technical Considerations == |
|||
* [[DesignDecisions]] - covers design decisions (FIXME - this needs to be split up) |
|||
* [[Storage]] - How MediaGoblin's internal storage system works. |
|||
* [[Processing]] - What happens after you submit your image/video/etc? Processing! More about that. |
|||
* [https://gitorious.org/mediagoblin/mediagoblin/blobs/master/extlib/README External Library Policy] - covers use of external libraries |
|||
== Become a User == |
|||
= Deploying MediaGoblin = |
|||
Coming soon! |
|||
We’re building MediaGoblin for us and for you but really you’re one of us and I am you and we are we and MediaGoblin is the walrus. |
|||
We're planning to launch our own public instance of MediaGoblin in the near future--probably in the September/October 2011 time frame. When we do, sign up for an account, use the service and relish in the thought that this service comes with a heaping side of Freedom and you can salt and pepper it to your liking. |
|||
== Help Others == |
|||
Have you spent time with MediaGoblin? If so, your experience and wisdom are invaluable and you’re the best person we can think of to help other users with their questions. |
|||
Hang out on the IRC channel and help answer new peoples' questions. See [http://mediagoblin.org/join/ our join page] for links. |
|||
== Run your own MediaGoblin Instance == |
|||
Are there things about our instance you want to change? Are there things about other instances you wish were different? Want to test upcoming changes? Want to create patches to implement things you need? That’s great—you can run your own instance! |
|||
* [[Configure_MediaGoblin|Configuration]] - Learn about MediaGoblin configuration files and file options. |
* [[Configure_MediaGoblin|Configuration]] - Learn about MediaGoblin configuration files and file options. |
||
Line 34: | Line 88: | ||
* [[Virtual Machine Hosting]] - Deploy your own publicly available MediaGoblin server using [http://aws.amazon.com/free/?utm_source=adwords&utm_medium=cpc&utm_campaign=CPC_Google_AWS_ec2&utm_content=TextV01_PP_V01_EC2&trk=CPC_Google_AWS_ec2 Amazon's free EC2 tier]. |
* [[Virtual Machine Hosting]] - Deploy your own publicly available MediaGoblin server using [http://aws.amazon.com/free/?utm_source=adwords&utm_medium=cpc&utm_campaign=CPC_Google_AWS_ec2&utm_content=TextV01_PP_V01_EC2&trk=CPC_Google_AWS_ec2 Amazon's free EC2 tier]. |
||
= Want to try out GNU MediaGoblin? = |
|||
== Create a Theme == |
|||
* If you want to run your own server to test the best information is currently in the [[HackingHowto]] |
|||
* There's info on a server you can test on our [[User Experience]] page |
|||
Coming soon! |
|||
== Testing and Release Guidelines == |
|||
* [[UnitTests|Unit Tests]] - all about the unit tests |
|||
* [[User Experience]] - user experience testing. Includes link to an instance you can try! |
|||
* [[ReleaseProcess|Release Process]] - covers the release process |
|||
MedaGoblin development is premised on the idea that the entire interface for the platform be completely theme-able. If you have a design or theming background, consider developing themes for MediaGoblin. New themes help test the theming system, provide attractive and appealing interfaces for prospective users. If you want to start a new theme but don’t know where to start, touch base with the development community on the list or in the IRC channel for more information. |
|||
= Inner workings of the secret sanctum (Contacting the team) = |
|||
* [http://mediagoblin.org/irclogs/ IRC meeting logs] |
|||
* [[IRCBot]] - covers our irc bot |
|||
= Project Miscellany = |
|||
= Technical project documentation = |
|||
* [http://python.mirocommunity.org/video/4337/gnu-mediagoblin-for-a-federate A video with Chris Webber talking about MediaGoblin] at [http://chipy.org ChiPy] |
|||
* [[DesignDecisions]] - covers design decisions (FIXME - this needs to be split up) |
|||
* [[Storage]] - How MediaGoblin's internal storage system works. |
|||
* [[Processing]] - What happens after you submit your image/video/etc? Processing! More about that. |
|||
* [https://gitorious.org/mediagoblin/mediagoblin/blobs/master/extlib/README External Library Policy] - covers use of external libraries |
|||
* [[User:Cwebber/braindumps]] - Chris Webber's braindumps (you can help refactoring these into real sections of the site!) |
* [[User:Cwebber/braindumps]] - Chris Webber's braindumps (you can help refactoring these into real sections of the site!) |
||
= Inner workings of the secret sanctum = |
|||
* [http://mediagoblin.org/irclogs/ IRC meeting logs] |
|||
* [[IRCBot]] - covers our irc bot |
|||
* [[ReleaseProcess|Release Process]] - covers the release process |
|||
* [[Update the website]] - Learn how to update mediagoblin.org! |
* [[Update the website]] - Learn how to update mediagoblin.org! |
Revision as of 13:31, 4 September 2011
Want to Join the MediaGoblin Community?
We’re really glad that you want to join the MediaGoblin community!
There are a variety of ways to help and support MediaGoblin and to join the team. If you want to code, great, if not, even better! MediaGoblin interested contributors in many different roles: users, system administrators, technical writers, testers, evangelists, UI/UX and graphics designers, cheerleaders, and dreamers.
This wiki covers a variety of ways that you can get involved with MediaGoblin as well as instructions on how to get started.
Hang out with the MediaGoblin folk
MediaGoblin has a mailing list and an IRC channel where we hang out. See our join page for links.
Please drop by and say “Hi!” And, if you’re looking for something to do, just ask---there’s always work to be done.
File Bugs / Triage Bugs
Issue reports are critical for all projects. Identified bugs give developers a basis for beginning work, and providing an idea of what features and issues are most important to users and the overall usability of the software. If you identify errors, flaws, unexpected behaviors, or deficits that impede use, file a bug.
- File Bugs -- notes on filing new bugs/issues/feature requests
- Triage Bugs -- notes on triaging
Write Code / Fix Code
If you are a coder and you would like to write code, the repository is hosted on gitorious. Clone or fork the repository and start poking around. Become familiar with this manual for an overview of how the software works and is used. Consider the contributor wiki for more information about the project, our preferred methods, and guides for developing MediaGoblin. We even have tips on becoming a coder and we’re willing to help!
- Development quick start - get MediaGoblin running on your own machine so you can hack on it
- Hacking - notes on making and sending in code contributions
- Beginner's Corner - resources for those who are new to Python, MongoDB, or Git.
- We'll be adding some distribution/OS specific hacking guides as separate pages soon.
- Git workflow - How to go about submitting patches via git.
- Templating - How our templating structure is set up
Send Encouragement / Spread the Word
Sometimes, a nice word, simple encouragement, and interest in the work we’re doing is enough to inspire a tizzy of productive work. Just a bit more interest and encouragement can even make the difference between a complete feature and limited functionality; between a completed milestone and lost momentum.
Similarly, MediaGoblin, and the movement for free network services, is always in need of encouragement. Use free network services, understand the principals behind the movement, be able to articulate the benefits of free network services and the problems with psudo-free applications that don’t respect the users’ freedom.
Write a blog post, post a status update, drop by the listserv or join #mediagoblin on freenode.net and let us know. See our join page for links.
Write Documentation / Edit Documentation
- Documentation quick start - How to contribute to the documentation effort.
- ManualStandards - covers the standards for writing the user manual (forthcoming.)
Test MediaGoblin
- Unit Tests - all about the unit tests
- User Experience - user experience testing. Includes link to an instance you can try!
Translate MediaGoblin
If you know English and another language and feel comfortable translating elements of the interface or even the documentation, we’d love to have help translating the software and resources.
- Translations - How to translate stuff or update the translations
Become a User
Coming soon!
We’re building MediaGoblin for us and for you but really you’re one of us and I am you and we are we and MediaGoblin is the walrus.
We're planning to launch our own public instance of MediaGoblin in the near future--probably in the September/October 2011 time frame. When we do, sign up for an account, use the service and relish in the thought that this service comes with a heaping side of Freedom and you can salt and pepper it to your liking.
Help Others
Have you spent time with MediaGoblin? If so, your experience and wisdom are invaluable and you’re the best person we can think of to help other users with their questions.
Hang out on the IRC channel and help answer new peoples' questions. See our join page for links.
Run your own MediaGoblin Instance
Are there things about our instance you want to change? Are there things about other instances you wish were different? Want to test upcoming changes? Want to create patches to implement things you need? That’s great—you can run your own instance!
- Configuration - Learn about MediaGoblin configuration files and file options.
- Deployment - General deployment advice
- Scaling Down - Minimizing MediaGoblin's resource requirements
- Virtual Machine Hosting - Deploy your own publicly available MediaGoblin server using Amazon's free EC2 tier.
Create a Theme
Coming soon!
MedaGoblin development is premised on the idea that the entire interface for the platform be completely theme-able. If you have a design or theming background, consider developing themes for MediaGoblin. New themes help test the theming system, provide attractive and appealing interfaces for prospective users. If you want to start a new theme but don’t know where to start, touch base with the development community on the list or in the IRC channel for more information.
Technical project documentation
- DesignDecisions - covers design decisions (FIXME - this needs to be split up)
- Storage - How MediaGoblin's internal storage system works.
- Processing - What happens after you submit your image/video/etc? Processing! More about that.
- External Library Policy - covers use of external libraries
- User:Cwebber/braindumps - Chris Webber's braindumps (you can help refactoring these into real sections of the site!)
Inner workings of the secret sanctum
- IRC meeting logs
- IRCBot - covers our irc bot
- Release Process - covers the release process
- Update the website - Learn how to update mediagoblin.org!