| Line 1: | Line 1: | ||
| - | + | == Creating SDK Tutorial Process == | |
| - | + | This page includes recommendations for the content of MeeGo SDK tutorials, following the [SDK_documentation_guidelines documentation process]: | |
| - | == | + | # Create a documentation bug |
| - | + | # Create wiki content (w/source, screenshots, etc) | |
| - | + | # Request review, update bug. | |
| - | + | # Add link to your wiki page in the appropriate section of the [Developer_Guide_for_MeeGo_1.0 Developer's page] | |
| - | + | ||
| - | + | ||
== Content and Formatting == | == Content and Formatting == | ||
| - | The content of the tutorial is up to you but it should be concise and accurate. | + | The content of the tutorial is up to you but it should be concise and accurate. In addition, the following components are recommended if applicable: |
* Environment setup | * Environment setup | ||
* Sample code (with good coding style) | * Sample code (with good coding style) | ||
* Screenshots | * Screenshots | ||
| + | If you are not the expert, be clear to note that. For example: "Here is one way to <perform this feature>. There may be better ways." | ||
| - | + | === Links to content outside wiki === | |
| - | + | Links to offsite content is not encouraged. Advertising, spam, or other inappropriate content will be removed and the author banned from further contributions. | |
=== Formatting === | === Formatting === | ||
| - | Wiki standards should be used and look similar to [Developer_Guide_for_MeeGo_1.0 other tutorial pages] | + | Wiki standards should be used and look similar to [Developer_Guide_for_MeeGo_1.0 other tutorial pages]: |
* Capitalize first letter of all title words. Correct: My Tutorial About Foo Incorrect: My tutorial about foo | * Capitalize first letter of all title words. Correct: My Tutorial About Foo Incorrect: My tutorial about foo | ||
* Headings should be level 2 (== Heading ==). Sub-headings level 3 (=== Sub-headings ===). | * Headings should be level 2 (== Heading ==). Sub-headings level 3 (=== Sub-headings ===). | ||
| Line 30: | Line 29: | ||
=== Source Code === | === Source Code === | ||
| - | + | Source code is important whenever possible. | |
| - | * take | + | Code snippets should be shown inside boxes like this |
| - | * | + | When providing source, be aware of the following: |
| - | * | + | * License. If the source is not original, you must take appropriate attribution according to the source license. |
| + | * Style. Code should follow good coding style. | ||
| + | * Review. If possible, have area experts review the tutorial. | ||
| + | * Simplicity. Keep it simple and clear. Only include the minimal code to showcase the feature. | ||
==== Full, buildable, samples ==== | ==== Full, buildable, samples ==== | ||
| - | + | If your code is large, you may want to create a project in a public git repository. You can also optionally post a tgz or bz2 zipped archive. * Qt projects: If the project is Qt, it should be buildable with: qmake && make && make install | |
| - | + | * non-Qt projects: If the project is not Qt, it should be buildable with: autogen.sh && make && make install | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
Contents |
This page includes recommendations for the content of MeeGo SDK tutorials, following the [SDK_documentation_guidelines documentation process]:
The content of the tutorial is up to you but it should be concise and accurate. In addition, the following components are recommended if applicable:
If you are not the expert, be clear to note that. For example: "Here is one way to <perform this feature>. There may be better ways."
Links to offsite content is not encouraged. Advertising, spam, or other inappropriate content will be removed and the author banned from further contributions.
Wiki standards should be used and look similar to [Developer_Guide_for_MeeGo_1.0 other tutorial pages]:
Links to your new tutorial should be placed on the main developer page after a peer review and only when it is ready for developers to use.
Screenshots are encouraged if helpful.
Source code is important whenever possible.
Code snippets should be shown inside boxes like this
When providing source, be aware of the following:
If your code is large, you may want to create a project in a public git repository. You can also optionally post a tgz or bz2 zipped archive. * Qt projects: If the project is Qt, it should be buildable with: qmake && make && make install