(→Developer Guide process) |
(→Developer Guide process) |
||
| Line 3: | Line 3: | ||
= Developer Guide process = | = Developer Guide process = | ||
| - | The intention behind the Developer Guide is to sign-post the most-accurate information available to MeeGo developers. As such, it should not be added to in an ad hoc fashion. | + | The intention behind the Developer Guide is to sign-post the most-accurate information available to MeeGo developers. As such, it should not be added to in an ad hoc fashion or subjected to massive restructurings without community involvement. Usual MeeGo SDK community channels can be used to discuss changes. |
| - | If you notice | + | If you notice an improvement which could be made to the Developer Guide, you have a few options: |
* Fix it yourself (if it's already in the guide); let the meego-sdk mailing list know if it's anything significant (e.g. you removed or added a large chunk of text; fixing typos is OK and you don't need to tell anyone) | * Fix it yourself (if it's already in the guide); let the meego-sdk mailing list know if it's anything significant (e.g. you removed or added a large chunk of text; fixing typos is OK and you don't need to tell anyone) | ||
| Line 11: | Line 11: | ||
* Log an enhancement request for a page to be added to the Developer Guide if you can't or won't write it yourself | * Log an enhancement request for a page to be added to the Developer Guide if you can't or won't write it yourself | ||
* Log a bug if you spot a problem on a page (something wrong, something missing) and can't or won't fix it yourself | * Log a bug if you spot a problem on a page (something wrong, something missing) and can't or won't fix it yourself | ||
| + | * Requests to remove a page, move a page out of the guide etc. can also be made through bugzilla | ||
Bugs and enhancement requests are logged on http://bugs.meego.com/, inside the ''Documentation'' product, ''SDK docs'' component. | Bugs and enhancement requests are logged on http://bugs.meego.com/, inside the ''Documentation'' product, ''SDK docs'' component. | ||
A set of documentation principles describing the documentation process and the different licenses for different documents.
The intention behind the Developer Guide is to sign-post the most-accurate information available to MeeGo developers. As such, it should not be added to in an ad hoc fashion or subjected to massive restructurings without community involvement. Usual MeeGo SDK community channels can be used to discuss changes.
If you notice an improvement which could be made to the Developer Guide, you have a few options:
Bugs and enhancement requests are logged on http://bugs.meego.com/, inside the Documentation product, SDK docs component.
Documentation issues should also be attached to the appropriate version of the Developer Guide (corresponding to MeeGo versions): check the version of the Developer Guide you're viewing and select the appropriate version when making your request.
We need to start applying some kind of categorisation system to make it easy to find documents relating to the backlog (see Developer guide content organisation for some suggestions).
Creative Commons Attribution 3.0 is the licence for the wiki; documentation uses the same licence