Main Page: Difference between revisions
(Added functional testing section) |
SturmAdmin2 (talk | contribs) |
||
| (63 intermediate revisions by 44 users not shown) | |||
| Line 9: | Line 9: | ||
This wiki covers a variety of ways that you can get involved with MediaGoblin as well as instructions on how to get started. |
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. |
|||
== Hang out with the MediaGoblin folk == |
|||
MediaGoblin has a mailing list and an IRC channel where we hang out. See [http://mediagoblin.org/pages/join.html 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. |
|||
== Take Part in the Monthly Meetings == |
|||
Each month is a [[:Category:Meeting|Meeting]]. You can take part and help decide on the future of MediaGoblin. Or just be around and see what's happening live! |
|||
=How Can you help ?= |
=How Can you help ?= |
||
First and foremost, for many (but not all) types of contributions you may want to set up a local instance. To learn how to do this, see the [[HackingHowto]] page. (If you're not familiar with command line level things, there are still ways you can help below!) |
|||
== File Bugs / Triage Bugs == |
== File Bugs / Triage Bugs == |
||
| Line 32: | Line 22: | ||
* [[Feature Ideas]] -- notes on possible features |
* [[Feature Ideas]] -- notes on possible features |
||
* [[Triage Bugs]] -- notes on triaging |
* [[Triage Bugs]] -- notes on triaging |
||
* [[BugTriageDay]] -- every other Thursday is bug triage day where anyone can help out triaging bugs |
|||
== Send Encouragement / Spread the Word == |
== Send Encouragement / Spread the Word == |
||
| Line 41: | Line 29: | ||
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. |
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 [ |
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 == |
== Write Documentation / Edit Documentation == |
||
| ⚫ | |||
* [[Documentation quick start]] - How to contribute to the documentation effort. |
|||
| ⚫ | |||
== Test MediaGoblin == |
== Test MediaGoblin == |
||
| Line 56: | Line 42: | ||
* [[User Experience]] - user experience testing. Includes link to an instance you can try! |
* [[User Experience]] - user experience testing. Includes link to an instance you can try! |
||
* [[UnitTests|Unit Tests]] - all about the unit tests |
* [[UnitTests|Unit Tests]] - all about the unit tests |
||
| ⚫ | |||
| Line 64: | Line 51: | ||
* [[Translations]] - How to translate stuff or update the translations |
* [[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 [http://mediagoblin.org/join/ our join page] for links. |
|||
| Line 89: | Line 61: | ||
* [[Configure_MediaGoblin|Configuration]] - Learn about MediaGoblin configuration files and file options. |
* [[Configure_MediaGoblin|Configuration]] - Learn about MediaGoblin configuration files and file options. |
||
* [[Deployment]] - General deployment advice |
* [[Deployment]] - General deployment advice |
||
* [[Scaling Down]] - Minimizing MediaGoblin's resource requirements |
|||
* [[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]. |
||
| Line 103: | Line 74: | ||
== Write Code / Fix Code == |
== 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! |
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! |
||
| Line 112: | Line 83: | ||
* [[Git workflow]] - How to go about submitting patches via git. |
* [[Git workflow]] - How to go about submitting patches via git. |
||
* [[Code review tips]] - Tips on how to go about doing local code review |
* [[Code review tips]] - Tips on how to go about doing local code review |
||
* [[Templating]] - How our templating structure is set up |
|||
* [[Code overview]] - Overview of the structure of the codebase |
|||
== Create a Theme == |
|||
See [http://docs.mediagoblin.org/siteadmin/theming.html the theming docs] |
|||
== Write a plugin == |
== Write a plugin == |
||
| Line 131: | Line 96: | ||
[[PluginsTips|Plugins Tips]] |
[[PluginsTips|Plugins Tips]] |
||
| ⚫ | |||
== Manual functional testing == |
|||
One easy way to get involved is to help with functional testing. You can find details on this here: |
|||
| ⚫ | |||
= Misc = |
|||
| ⚫ | |||
See [[Android Client]] |
See [[Android Client]] |
||
| Line 145: | Line 102: | ||
= Inner workings of the secret sanctum = |
= Inner workings of the secret sanctum = |
||
* [[IRCBot]] - covers our irc bot |
|||
* [[ReleaseProcess|Release Process]] - covers the release process |
* [[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! |
||
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!