<div>Justin,</div><div><br></div><div>Thank-you.</div><div><br></div><span class="Apple-style-span" style="font-weight: bold;"><span class="Apple-style-span" style="font-style: italic;">> First, I'll join Sean in thanking you for doing some work here, Mark. I think </span></span><div>
<span class="Apple-style-span" style="font-weight: bold;"><span class="Apple-style-span" style="font-style: italic;">> that it can be a thankless task but any reversal of entropy is good. </span></span><div><div><br></div>
<div>No problem, thank-you for taking the time to say thank-you. Documentation is never fun... but it needs to be done. ;-)</div><div><br></div><div><span class="Apple-style-span" style="font-weight: bold;"><span class="Apple-style-span" style="font-style: italic;">> In general, if I were you I'd concentrate on curating pages more than cleaning</span></span></div>
<div><span class="Apple-style-span" style="font-weight: bold;"><span class="Apple-style-span" style="font-style: italic;">> them up. </span></span></div><div><br></div><div>I slightly disagree. I personally believe that the first task is to comb through the current WIKI and figure out what we have, so we have an idea of what still needs to be done. I've found instances of duplicate pages, and there is no reason for us to "duplicate" our efforts. I believe the first step, is organizing and combing through what pages we already have first, cleaning things up a bit, and doing a bit of updating (and spell checking) as I go. Tagging all the pages properly (with page tags for pages that need examples or need a bit of updated content, or need clarification, or simply tag the "proposal" pages with the "proposal" tag).</div>
<div><br></div><div>Once all the WIKI pages are properly tagged (and "cleaned up") and navigation links have all been added, it makes finding things a bit easier for new users. At the same time, it makes figuring out which existing pages that we already have need to be updated, and makes finding pages that need clarification (or need to be updated with examples) quite a bit easier as well (as I simply just add the "ToDo" category tag. All those pages I have added to the "Todo" category just need to be reviewed, or may need a bit of updated content, or some additional examples. </div>
<div><br></div><div>This way ANYONE wishing to help update WIKI content can easily just grab one of those pages from the "todo" category, and begin working on updating content.</div><div><br></div><div>Once the WIKI has been completely cleaned up (and all the navigation links have been added), I've also been adding a "See Also" heading to all the updated pages (with similarly related subject material). This will make it much easier for new users to find what they are looking for, and to navigate the WIKI. I've been adding key words, and adding titles to many of the pages, so they show up better when using the WIKI search function.</div>
<div><br></div><div>Once I'm done with all the current stuff that we have, (and I've been taking notes as I go, as to what areas need work) then later I can always go back and add content to those areas/pages. Then eventually once that is completed, then I'll work on adding video tutorials and screencasts, but that could easily be after Christmas before I even get that far. ;-) </div>
<div><br></div><div>I want to do normal text tutorials first, and then later I'll add screencast links (to the WIKI media section).</div><div><br></div><div><span class="Apple-style-span" style="font-weight: bold;"><span class="Apple-style-span" style="font-style: italic;">>I think that making them easily findable in the first place will make them more</span></span></div>
<div><span class="Apple-style-span" style="font-weight: bold;"><span class="Apple-style-span" style="font-style: italic;">> likely over time to be either cleaned up by other people over time or</span></span></div><div>
<span class="Apple-style-span" style="font-weight: bold;"><span class="Apple-style-span" style="font-style: italic;">> disposed.</span></span></div><div><br></div><div>I agree that navigation is probably most important at this point, but I've found that it's easiest to just tag pages as I'm updating the navigation. </div>
<div><br></div><div>If we all just sit and wait patiently for someone else to do it, then usually it simply just doesn't get done. By at least taking the initiative to tag all the pages, at least it'll make it easier for others to see what still needs to be done. So I'm just taking the time now and going page by page adding navigation links and quickly reviewing each page (for spelling errors, etc.) and I quickly look over the content as well (for portions that may need better examples, etc.) and properly tag all the pages that need additional examples, or updated content. This way others can easily check the "todo" category, and see the tagged pages (and begin working on reviewing and updating those pages).</div>
<div><br></div><div>It's a fairly daunting task to skim through everything once, I'd really hate to have to do it twice. No reason to do the same work twice. So it seems much easier to just go through page by page and do everything at once (tags, navigation links, and "See Also" headings), and just slowly tackle things page by page. That way I just scratch those pages off my list.</div>
<div><br></div><div>At least this way I know what we have, and have a good idea of what still needs to be done (and what pages need work), and as I find pages that seem to be "lost" or "hidden" pages (no tags or no links) or find duplicate pages. Then at least I can tag those pages that need to be merged, or tag the obsolete pages with notes for deletion (add the "todelete" tag). </div>
<div><br></div><div>This way later we can go back and merge the content on those duplicate pages, and delete any unnecessary (old or outdated) pages. </div><div><br></div><div>Ok, enough chat. Back to work. </div><div>
<br></div><div>I'll slowly post a list of pages here that may need some work/help from the actual developers, because certain pages (those pertaining to a list of commands or functions, status pages, etc.) So at least the developers can quickly glance at them, and update any content that they are familiar with (or pages that may fall within their "area of interest" in the project).</div>
<div><br></div><div>Any remaining pages, I may come back in a month or so and ask for some specific help/details, but I have to say some of the pages that Diva has done, and some of the other developers really are great pages.</div>
<div><br></div><div>I seen some very nice recently added pages with very good examples, good flow charts, very easy to read, very easy to follow, very easy to understand, etc. So I just want to thank the developers for their hard work with helping to maintain documentation. The recent "proposal" pages from Diva/Melanie looked great! So thank-you ALL for your hard work.</div>
<div><br></div><div> Thanks,</div><div><br></div><div> Mark</div><div><br></div><div><br><div class="gmail_quote">On Fri, May 22, 2009 at 10:27 AM, Justin Clark-Casey <span dir="ltr"><<a href="mailto:jjustincc@googlemail.com">jjustincc@googlemail.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;"><div class="im">Mark Malewski wrote:<br>
> Dev-Group,<br>
><br>
<br>
</div>First, I'll join Sean in thanking you for doing some work here, Mark. I think that it can be a thankless task but any<br>
reversal of entropy is good. And general thanks to anybody who has worked on the wiki so far.<br>
<div class="im"><br>
> Ok, I've been working (as much as I possibly can) on creating pages,<br>
> improving navigation links, and improving the current WIKI<br>
> documentation, but there are quite a few pages that still need updating<br>
> (and I'm clueless as to what information should go on a few of these<br>
> pages). I've added some pages, and some pages are a bit out of date<br>
> (and need updated content), so I really need some help from the core<br>
> developers on updating each of these following pages:<br>
><br>
><br>
> <a href="http://opensimulator.org/wiki/Sim_Throttles" target="_blank">http://opensimulator.org/wiki/Sim_Throttles</a> - What is this page?<br>
> What is the name "Sim_Throttles", and where did it come from? Is there<br>
> an actual event or function called "Sim_Throttles" or<br>
> "OpenSim_Throttles"? This page needs some updating from one of the core<br>
> developers familiar with this, also should the name be changed from<br>
> "Sim_Throttles" to "OpenSim_Throttles"?<br>
<br>
</div>This relates to the code which controls the flow of data from the server to the client. It corresponds to the<br>
information you'll see in the Linden Lab Second Life client stats (texture data, object data, etc.). Sim throttles is a<br>
better name than OpenSim Throttles, though perhaps something like Client Data Throttles is even better.<br>
<div class="im"><br>
><br>
> Also the following GridServer pages need work:<br>
> <a href="http://opensimulator.org/wiki/GridServer" target="_blank">http://opensimulator.org/wiki/GridServer</a><br>
> <<a href="http://opensimulator.org/wiki/GridServer/ClientDocs" target="_blank">http://opensimulator.org/wiki/GridServer/ClientDocs</a>><br>
> <a href="http://opensimulator.org/wiki/GridServer/ClientDocs" target="_blank">http://opensimulator.org/wiki/GridServer/ClientDocs</a> -<br>
> GridServer Client Documentation Page<br>
> <a href="http://opensimulator.org/wiki/GridServer/DeveloperDocs" target="_blank">http://opensimulator.org/wiki/GridServer/DeveloperDocs</a><br>
> <<a href="http://opensimulator.org/wiki/GridServer/ClientDocs" target="_blank">http://opensimulator.org/wiki/GridServer/ClientDocs</a>> - GridServer<br>
</div>> Developer Documentation Page<br>
<br>
I'm not sure what this is. Some of the stuff it talks about (e.g. fetching assets from various urls) has not been<br>
implemented, so I don't know if it's old or new.<br>
<br>
In general, if I were you I'd concentrate on curating pages more than cleaning them up. I think that making them easily<br>
findable in the first place will make them more likely over time to be either cleaned up by other people over time or<br>
disposed.<br>
<div class="im"><br>
><br>
> Also where can I find out the current LSL and OSSL "Types Status" and<br>
> "Events Status"? Where does this information come from? Mantis? I'm<br>
> trying to figure out how to update those pages, but I'm just not sure<br>
> where the "Type Status" and "Event Status"<br>
> information/numbers/statistics/completion stats comes from. Please help<br>
> me find this information, and update the pages accordingly.<br>
><br>
> I've updated the navigation on these pages, but please review the<br>
> content on all of these pages to see if the content needs to be updated<br>
> as well. I believe all the OpenSim "Current Status" pages need to be<br>
> reviewed and updated accordingly as well:<br>
> <a href="http://opensimulator.org/wiki/LSL_Status" target="_blank">http://opensimulator.org/wiki/LSL_Status</a> - LSL Status Page<br>
> <a href="http://opensimulator.org/wiki/LSL_Status/Types" target="_blank">http://opensimulator.org/wiki/LSL_Status/Types</a> - LSL Types Status<br>
> Page<br>
> <a href="http://opensimulator.org/wiki/LSL_Status/Events" target="_blank">http://opensimulator.org/wiki/LSL_Status/Events</a> - LSL Events<br>
> Status Page<br>
> <a href="http://opensimulator.org/wiki/LSL_Status/Types" target="_blank">http://opensimulator.org/wiki/LSL_Status/Types</a> - LSL Status Page<br>
> <a href="http://opensimulator.org/wiki/OSSL_Status" target="_blank">http://opensimulator.org/wiki/OSSL_Status</a><br>
</div>> <<a href="http://opensimulator.org/wiki/LSL_Status" target="_blank">http://opensimulator.org/wiki/LSL_Status</a>> - OSSL<br>
<div class="im">> Status Page<br>
> <a href="http://opensimulator.org/wiki/OSSL_Status/Types" target="_blank">http://opensimulator.org/wiki/OSSL_Status/Types</a><br>
</div>> <<a href="http://opensimulator.org/wiki/LSL_Status/Types" target="_blank">http://opensimulator.org/wiki/LSL_Status/Types</a>> - OSSL Types<br>
<div class="im">> Status Page<br>
> <a href="http://opensimulator.org/wiki/OSSL_Status/Events" target="_blank">http://opensimulator.org/wiki/OSSL_Status/Events</a><br>
</div>> <<a href="http://opensimulator.org/wiki/LSL_Status/Events" target="_blank">http://opensimulator.org/wiki/LSL_Status/Events</a>> - OSSL Events<br>
<div class="im">> Status Page<br>
> <a href="http://opensimulator.org/wiki/OSSL_Status/Types" target="_blank">http://opensimulator.org/wiki/OSSL_Status/Types</a><br>
</div>> <<a href="http://opensimulator.org/wiki/LSL_Status/Types" target="_blank">http://opensimulator.org/wiki/LSL_Status/Types</a>> - OSSL Status Page<br>
<br>
I think much of this information stems from the days when Alondria and CharlieO were working on that area (neither are<br>
still active), though I'm sure people have updated these lists since then.<br>
<br>
I imagine that the data itself came chiefly from direct testing, ckrinke's paper OpenSim notebook and code inspection<br>
(e.g. OpenSim/Region/ScriptEngine/Shared/Api/LSL_Api.cs) and comparisons with lsl wiki pages.<br>
<div class="im"><br>
><br>
><br>
> Please give me some feedback, and/or update the content on the WIKI<br>
> pages listed above (or if you are not comfortable with updating the<br>
> WIKI, please just send me the correct text that should be posted on the<br>
> WIKI page in an E-mail off-list, and I'll copy and paste the text to the<br>
> WIKI page, and update any necessary formatting, grammatical corrections,<br>
> etc). I just need some updated content for these WIKI pages. Thank-you!<br>
><br>
> Mark<br>
><br>
> P.S. I'm still currently working on the OSSL pages, so please give me<br>
> another hour or two to finish up all the OSSL template pages before<br>
> adding any content or updating the OSSL pages. Thanks!<br>
><br>
><br>
</div>> ------------------------------------------------------------------------<br>
<div class="im">><br>
> _______________________________________________<br>
> Opensim-dev mailing list<br>
> <a href="mailto:Opensim-dev@lists.berlios.de">Opensim-dev@lists.berlios.de</a><br>
> <a href="https://lists.berlios.de/mailman/listinfo/opensim-dev" target="_blank">https://lists.berlios.de/mailman/listinfo/opensim-dev</a><br>
<br>
--<br>
</div>justincc<br>
<font color="#888888">Justin Clark-Casey<br>
<a href="http://justincc.wordpress.com" target="_blank">http://justincc.wordpress.com</a><br>
</font><div><div></div><div class="h5">_______________________________________________<br>
Opensim-dev mailing list<br>
<a href="mailto:Opensim-dev@lists.berlios.de">Opensim-dev@lists.berlios.de</a><br>
<a href="https://lists.berlios.de/mailman/listinfo/opensim-dev" target="_blank">https://lists.berlios.de/mailman/listinfo/opensim-dev</a><br>
</div></div></blockquote></div><br></div></div></div>