Main Page: Difference between revisions
SturmAdmin2 (talk | contribs) |
|||
| (159 intermediate revisions by 69 users not shown) | |||
| 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! |
|||
In this wiki you will find beasts the likes of which you have never laid eyes on before! Expand your imagination, ladies and gentlemen, and examine the errata in this corpus of knowledge. May it transform you and let you see the world in a new light forevermore. |
|||
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. |
|||
We observe the [https://www.djangoproject.com/conduct/ Django code of conduct]. Be welcoming, friendly, and patient! |
|||
== Want to hack on GNU MediaGoblin? == |
|||
This wiki covers a variety of ways that you can get involved with MediaGoblin as well as instructions on how to get started. |
|||
== Visit MediaGoblin Live Instances == |
|||
Browse MediaGoblin [[Live instances|live instances]], add new ones and comment on those that appear to be down. |
|||
=How Can you help ?= |
|||
== 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 |
|||
* [[Feature Ideas]] -- notes on possible features |
|||
* [[Triage Bugs]] -- notes on triaging |
|||
== 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 [https://mediagoblin.org/pages/join.html our join page] for links. |
|||
== Write Documentation / Edit Documentation == |
|||
* [[ManualStandards]] - covers the standards for writing the user manual (forthcoming.) |
|||
== Test MediaGoblin == |
|||
Do you have access to the web? Do you like sharing your opinions? If so, we need your help to test MediaGoblin! Testers play around with the current test instance, note what operating system and browser they use (notes on multiple set-ups are also helpful) and take some notes. That's it! It's a very important task that doesn't require any special knowledge and you're done in under an hour. Ready to help? |
|||
* [[User Experience]] - user experience testing. Includes link to an instance you can try! |
|||
* [[UnitTests|Unit Tests]] - all about the unit tests |
|||
* [[Manual_Functional_Testing|Manual Functional Testing]] - a great way to get to know MediaGoblin. |
|||
== 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. |
|||
Translating MediaGoblin is very easy with a web interface, so there is no programming knowledge required at all. |
|||
* [[HackingHowto]] - generally covers getting set up for hacking on GNU MediaGoblin |
|||
** FIXME - add distribution/OS specific hacking guides as separate pages here |
|||
* [http://python.mirocommunity.org/video/4337/gnu-mediagoblin-for-a-federate A video with Chris Webber talking about MediaGoblin] at [http://chipy.org ChiPy] |
|||
* [[Translations]] - How to translate stuff or update the translations |
* [[Translations]] - How to translate stuff or update the translations |
||
* [[UnitTests]] - all about the unit tests |
|||
* [[Configure MediaGoblin]] - how to configure MediaGoblin for all your local needs. |
|||
* [[Scaling Down]] - Minimizing MediaGoblin's resource requirements |
|||
== Inner workings of the secret sanctum (aka project documentation) == |
|||
== Run your own MediaGoblin Instance == |
|||
* [http://mediagoblin.org/irclogs/ IRC meeting logs] |
|||
* [[IRCBot]] - covers our irc bot |
|||
* [[ReleaseProcess]] - covers the release process |
|||
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! |
|||
* [[ManualStandards]] - covers the standards for writing the user manual |
|||
The primary documentation for this is at [http://docs.mediagoblin.org http://docs.mediagoblin.org] but here are some additional tips: |
|||
* [[Configure_MediaGoblin|Configuration]] - Learn about MediaGoblin configuration files and file options. |
|||
* [[Deployment]] - General deployment advice |
|||
* [[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]. |
|||
= Technical project documentation = |
|||
The technical docs, that are more finished and the ones that are better maintained near the code (so they stay up to date) are in the more technical chapters of the [http://docs.mediagoblin.org/ main documentation]. |
|||
* [[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 |
* [https://gitorious.org/mediagoblin/mediagoblin/blobs/master/extlib/README External Library Policy] - covers use of external libraries |
||
* [[DesignDecisions]] - covers design decisions (FIXME - this needs to be split up) |
|||
* [[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!) |
||
* [[Multiple media support]] - Design plan for multiple media support |
|||
== Write Code / Fix Code == |
|||
MediaGoblin 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. |
|||
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! |
|||
* [[HackingHowto|Hacking]] - notes on making and sending in code contributions |
|||
** [[BeginnersCorner|Beginner's Corner]] - resources for those who are new to Python or Git. |
|||
** ''Started from an older version of the Hacking Howto? We switched from buildout->virtualenv, so look at [[Moving from buildout to virtualenv]] for information on how to move over.'' |
|||
* [[Git workflow]] - How to go about submitting patches via git. |
|||
* [[Code review tips]] - Tips on how to go about doing local code review |
|||
== Write a plugin == |
|||
If you start, you'll find some basic documentation [http://docs.mediagoblin.org/#part-4-developer-s-zone| in the docs site] |
|||
You've made a plugin ? List it here : |
|||
[[Available_Plugins|Available plugins]] |
|||
You've written a plugin ? You got some tips to share ? A tutorial idea ? Please do : |
|||
[[PluginsTips|Plugins Tips]] |
|||
= Android client = |
|||
See [[Android Client]] |
|||
= Inner workings of the secret sanctum = |
|||
* [[ReleaseProcess|Release Process]] - covers the release process |
|||
* [[Update the website]] - Learn how to update mediagoblin.org! |
|||
=FAQ= |
|||
[[GMG FAQ]] |
|||
Latest revision as of 01:11, 17 October 2023
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.
We observe the Django code of conduct. Be welcoming, friendly, and patient!
This wiki covers a variety of ways that you can get involved with MediaGoblin as well as instructions on how to get started.
Visit MediaGoblin Live Instances
Browse MediaGoblin live instances, add new ones and comment on those that appear to be down.
How Can you help ?
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
- Feature Ideas -- notes on possible features
- Triage Bugs -- notes on triaging
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
- ManualStandards - covers the standards for writing the user manual (forthcoming.)
Test MediaGoblin
Do you have access to the web? Do you like sharing your opinions? If so, we need your help to test MediaGoblin! Testers play around with the current test instance, note what operating system and browser they use (notes on multiple set-ups are also helpful) and take some notes. That's it! It's a very important task that doesn't require any special knowledge and you're done in under an hour. Ready to help?
- User Experience - user experience testing. Includes link to an instance you can try!
- Unit Tests - all about the unit tests
- Manual Functional Testing - a great way to get to know MediaGoblin.
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. Translating MediaGoblin is very easy with a web interface, so there is no programming knowledge required at all.
- Translations - How to translate stuff or update the translations
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!
The primary documentation for this is at http://docs.mediagoblin.org but here are some additional tips:
- Configuration - Learn about MediaGoblin configuration files and file options.
- Deployment - General deployment advice
- Virtual Machine Hosting - Deploy your own publicly available MediaGoblin server using Amazon's free EC2 tier.
Technical project documentation
The technical docs, that are more finished and the ones that are better maintained near the code (so they stay up to date) are in the more technical chapters of the main documentation.
- 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!)
- Multiple media support - Design plan for multiple media support
Write Code / Fix Code
MediaGoblin 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.
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!
- Hacking - notes on making and sending in code contributions
- Beginner's Corner - resources for those who are new to Python or Git.
- Started from an older version of the Hacking Howto? We switched from buildout->virtualenv, so look at Moving from buildout to virtualenv for information on how to move over.
- Git workflow - How to go about submitting patches via git.
- Code review tips - Tips on how to go about doing local code review
Write a plugin
If you start, you'll find some basic documentation in the docs site
You've made a plugin ? List it here :
You've written a plugin ? You got some tips to share ? A tutorial idea ? Please do :
Android client
See Android Client
Inner workings of the secret sanctum
- Release Process - covers the release process
- Update the website - Learn how to update mediagoblin.org!