|
Size: 4038
Comment: update content - add link
|
Size: 4053
Comment: test
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 12: | Line 12: |
| Due to spammers, write access to this wiki is disabled by default. If you haven't already, please email your wiki username and the type(s) of edits you would like to make to <<MailTo(ANTI SPAM wiki AT libsdl DOT org)>> to be given write access and to coordinate efforts. | Due to spammers, write access to this wiki is disabled by default. If you haven't already, please email your wiki username and the kind(s) of edits you would like to make to <<MailTo(ANTI SPAM wiki AT libsdl DOT org)>> to be given write access and to coordinate efforts. |
| Line 30: | Line 30: |
| This is the quickest and simplest way to contribute! Every page of the wiki contains a drop down ''Feedback'' form (upper right) where you can post quick content ideas, questions, suggestions, etc. Simply click the form tab, fill in the text field with your contribution, and click ''Submit''. We'll take it from there! | . This is the quickest and simplest way to contribute! Every page of the wiki contains a drop down ''Feedback'' form (upper right) where you can post quick content ideas, questions, suggestions, etc. Simply click the form tab, fill in the text field with your contribution, and click ''Submit''. We'll take it from there! |
| Line 34: | Line 34: |
| The [[http://lists.libsdl.org/listinfo.cgi/docs-libsdl.org|Documentation Mailing List]] has been set up to allow users to share documentation-related topics. Anything from conventions to needed content, questions or comments, can be posted to the Mailing List. Plus, keep up with what others are saying and doing on the wiki. | . The [[http://lists.libsdl.org/listinfo.cgi/docs-libsdl.org|Documentation Mailing List]] has been set up to allow users to share documentation-related topics. Anything from conventions to needed content, questions or comments, can be posted to the Mailing List. Plus, keep up with what others are saying and doing on the wiki. |
| Line 36: | Line 36: |
| We encourage all contributors to join the mailing list and participate in the discussions there. It is a great place to discuss areas that need contributions and to let others know what you are working on or if you are able to help address a request. | . We encourage all contributors to join the mailing list and participate in the discussions there. It is a great place to discuss areas that need contributions and to let others know what you are working on or if you are able to help address a request. |
| Line 40: | Line 40: |
| These are the core of our contribution resources. There is a style guide for each type of contribution you may wish to make as well as the [[http://wiki.libsdl.org/moin.cgi/SGWikiBasics|Wiki Basics]] guide which contains global information that all contributors should have. | . These are the core of our contribution resources. There is a style guide for each type of contribution you may wish to make as well as the [[http://wiki.libsdl.org/moin.cgi/SGWikiBasics|Wiki Basics]] guide which contains global information that all contributors should have. |
| Line 42: | Line 42: |
| '''We recommend that you begin with Wiki Basics and then dive into the topic-specific guides that interest you before you begin to edit.''' Please check back periodically for reminders and updates! | . '''We recommend that you begin with Wiki Basics and then dive into the topic-specific guides that interest you before you begin to edit.''' Please check back periodically for reminders and updates! |
DRAFT |
Contributing
We are very pleased that you are interested in contributing! Here's what you need to know:
Due to spammers, write access to this wiki is disabled by default. If you haven't already, please email your wiki username and the kind(s) of edits you would like to make to <ANTI SPAM wiki AT libsdl DOT org> to be given write access and to coordinate efforts.
Thank you!
Our goal is to create the best documentation for SDL possible. To this end we have adopted the following guiding principles and would appreciate your keeping them in mind as you create your contributions.
- This wiki should:
- have a consistent look and feel throughout
- be easy to use
- be accurate
- contain high quality information
- be as simple and straight forward as possible
To help you with this we have created a series of resources:
Feedback Form
This is the quickest and simplest way to contribute! Every page of the wiki contains a drop down Feedback form (upper right) where you can post quick content ideas, questions, suggestions, etc. Simply click the form tab, fill in the text field with your contribution, and click Submit. We'll take it from there!
Mailing List
The Documentation Mailing List has been set up to allow users to share documentation-related topics. Anything from conventions to needed content, questions or comments, can be posted to the Mailing List. Plus, keep up with what others are saying and doing on the wiki.
- We encourage all contributors to join the mailing list and participate in the discussions there. It is a great place to discuss areas that need contributions and to let others know what you are working on or if you are able to help address a request.
Style Guides by Topic
These are the core of our contribution resources. There is a style guide for each type of contribution you may wish to make as well as the Wiki Basics guide which contains global information that all contributors should have.
We recommend that you begin with Wiki Basics and then dive into the topic-specific guides that interest you before you begin to edit. Please check back periodically for reminders and updates!
Style Guide |
Topics Covered |
starting to edit |
|
adding Code Examples to any API page |
|
[[|Remarks]] |
adding Remarks to any API page |
Coming Soon! |
adding an existing tutorial to the tutorials page |
It is very important to us that this wiki remains as friendly and professional as possible. We have created detailed style guides to help you ensure that your contributions fit in seamlessly and help to make the wiki that much better for other users.
If you find something that is not addressed or is unclear in a style guide please post your questions using the feedback form, the mailing list, or email us at <ANTI SPAM wiki AT libsdl DOT org>.
Email Contact
For anything that is not addressed in the above you can always send an email to <ANTI SPAM wiki AT libsdl DOT org>.
Disclaimer
All content modifications are subject to review for consistency and quality. We reserve the right to remove or modify any content added to this wiki at any time. You may direct questions or concerns to <ANTI SPAM wiki AT libsdl DOT org>.
