From: <tr...@do...> - 2013-02-01 10:42:22
|
<p>The following issue has been added to a project that you are monitoring.</p> <table border="0"> <tr> <td width="90px" valign="top"><b>Title:</b></td> <td>Migrate, rewrite and expand existing documentation using the BitBucket wiki</td> </tr> <tr> <td><b>Project:</b></td> <td>Website and Documentation</td> </tr> <tr> <td><b>Created By:</b></td> <td>Rob Vesse</td> </tr> <tr> <td><b>Milestone:</b></td> <td>1.0.x Releases</td> </tr> <tr> <td><b>Category:</b></td> <td>Documentation</td> </tr> <tr> <td><b>Priority:</b></td> <td>High</td> </tr> <tr> <td><b>Type:</b></td> <td>none</td> </tr> <tr> <td><b>Description:</b></td> </tr> <tr> <td colspan="2"><p> This is my key goal for the 1.0.0 release, for some time users have been complaining about the lack of documentation for certain things on the website. The website platform is unfortunately quite clunky for maintaining large bodies of documentation so I am proposing to move to the BitBucket wiki which I have used with considerable success for other projects like VDS.Common</p> <p> As part of migrating the documentation I will take the oppurtunity to expand and rewrite it as I go, key things I hope to add/change are as follows:</p> <ul> <li> Add a How To section with has succient, short examples of how to perform common tasks</li> <li> Much expanded FAQ</li> <li> Improve the Developer Guide portions substantially, move various existing architecture descriptions under this section</li> </ul> <p> I intend to replace the website as the primary source of documentation and use it just as a source of general information about the project pointing users to the wiki for documentation instead. I will redirect existing content on the website to the wiki wherever possible.</p> <p> Using the wiki should make it much easier to evolve the content over time and allows all the developers to maintain it if they so wish.</p></td> </tr> </table> <p> More information on this issue can be found at <a href="http://www.dotnetrdf.org/tracker/Issues/IssueDetail.aspx?id=306" target="_blank">http://www.dotnetrdf.org/tracker/Issues/IssueDetail.aspx?id=306</a></p> <p style="text-align:center;font-size:8pt;padding:5px;"> If you no longer wish to receive notifications, please visit <a href="http://www.dotnetrdf.org/tracker/Account/UserProfile.aspx" target="_blank">your profile</a> and change your notifications options. </p> |