Documentation for contribution authors
1.1 Submitting a contribution
1.2 Managing a contribution
1.3 Providing support
With this new contribution database for modifications and styles we understand that it might be a little confusing for you all. That's ok, we had to learn to work with it as well, but we're quite satisfied with the result of this new system. To make sure you all learn to work with it as well, but wrote up some quick guiding in order for you to submit and manage your contributions. If you've got any trouble using the system, you're welcome to ask your questions in the MOD Writers Discussion
Submitting a contribution
First, go to the Customisation Database
and click the "Create contribution" link at the top of the page. There you'll have to fill out a couple of fields related to your contribution.
- Name of the styles/modification you've created
- Clean version of the contribution name. It will appear in the URL for your contribution. If you don't fill this field out, it'll be created automaticly based on the name.
- Is this a modification or a style?
- Give a quick description of what this contribution will change or give value to a phpBB installation. It will be displayed on the contribution overview page. Smilies and BBCode can be used in this description.
After the description, you're going to have to fill out some other fields. The first place is for the categories
your contribution fits in. You can use the CTRL key to select more than one category at once. Keep in mind only to select the categories that are inside of your type of contribution. So do not select categories under the "Modification" heading when you're submitting a style.
The next two fields are optional and don't need to be filled out when there are no co-authors present. If there are, you can fill in their names as well, and the active co-authors will be able to manage the contribution and upload new versions as well, while the past contributors will still be mentioned on the overview page, they won't be able to change anything. The same counts for screenshots. When they are present, you can upload them at the bottom of the page, if they aren't it's no big deal. Keep in mind people like to see what they're downloading before they install it, so it makes your contribution attractive.
Managing a contribution
When you're in the Customisation Database
, you can see all the contributions that you made which are currently inside the database by clicking the "My contributions" link. On this page, you have a set of quick tools to manage them. These are:
- Edit the contribution settings (name, categories or description) and co-authors.
- Add a new revision of this modification to the queue.
- Discuss the denial or other things related to the contribution with the teams.
These page are usually very clear and don't need very much explaination. The settings page will allow you to edit the settings that you entered upon submitting the contribution, the revisions page will allow you to upload a new version of the contribution. This will be send to the queue for the appropriate team to validate. Don't forget to increment the version number. When a modification is denied, this will be posted by the validation team at the Discussion page in which you can read what you might have done wrong and if you don't agree you can explain your complaints.
In our former modification and styles database, support was given in one individual topic. With this system, we've changed this and split support up into two parts. The FAQ's and the Support area.
Go to the overview page of your contribution and click at the "FAQ" tab. There, you'll be able to add a new frequently asked question to the page by clicking the New FAQ button. There you can type the question and answer in the box, and give it an appropriate title. You can choose to have the FAQ to be available to the public, or have it to be limited to just authors, when it's still work in process or it's some instruction to your co-authors. This will display the "author-only" icon in that FAQ's row:
Go to the overview page of your contribution and click at the "Support/Discussion" tab. There, your users are able to start a new topic for an issue that the meet or something that isn't clear to them. We believe it's easier to have it split up in multiple topics having one topic per issue instead of having only one huge support topic. That makes it easier to handle and see what still needs to be done.
This works the same as the FAQs, you can limit access to the authors only, so you can use a topic to discuss issues brought up by the users with your possible fellow authors, or just have one comment in a public topic to be private, just like a note to yourself. You're also able to add stickies.
Well, we hope that this way, it's a little easier to understand this new database, and as said, you're always welcome to ask any questions you still have in the MOD Writers Discussion
More in-depth documentation will follow but this should help you get started with this new system.