[Opensim-dev] Core Developers... I need a little help...
Mark Malewski
mark.malewski at gmail.com
Sun May 24 15:07:34 UTC 2009
Justin,
Thank-you.
> 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 reversal of entropy is good.
No problem, thank-you for taking the time to say thank-you. Documentation
is never fun... but it needs to be done. ;-)
> In general, if I were you I'd concentrate on curating pages more than
cleaning
> them up.
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).
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.
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.
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.
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. ;-)
I want to do normal text tutorials first, and then later I'll add screencast
links (to the WIKI media section).
>I think that making them easily findable in the first place will make them
more
> likely over time to be either cleaned up by other people over time or
> disposed.
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.
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).
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.
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).
This way later we can go back and merge the content on those duplicate
pages, and delete any unnecessary (old or outdated) pages.
Ok, enough chat. Back to work.
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).
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.
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.
Thanks,
Mark
On Fri, May 22, 2009 at 10:27 AM, Justin Clark-Casey <
jjustincc at googlemail.com> wrote:
> Mark Malewski wrote:
> > Dev-Group,
> >
>
> 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
> reversal of entropy is good. And general thanks to anybody who has worked
> on the wiki so far.
>
> > Ok, I've been working (as much as I possibly can) on creating pages,
> > improving navigation links, and improving the current WIKI
> > documentation, but there are quite a few pages that still need updating
> > (and I'm clueless as to what information should go on a few of these
> > pages). I've added some pages, and some pages are a bit out of date
> > (and need updated content), so I really need some help from the core
> > developers on updating each of these following pages:
> >
> >
> > http://opensimulator.org/wiki/Sim_Throttles - What is this page?
> > What is the name "Sim_Throttles", and where did it come from? Is there
> > an actual event or function called "Sim_Throttles" or
> > "OpenSim_Throttles"? This page needs some updating from one of the core
> > developers familiar with this, also should the name be changed from
> > "Sim_Throttles" to "OpenSim_Throttles"?
>
> This relates to the code which controls the flow of data from the server to
> the client. It corresponds to the
> information you'll see in the Linden Lab Second Life client stats (texture
> data, object data, etc.). Sim throttles is a
> better name than OpenSim Throttles, though perhaps something like Client
> Data Throttles is even better.
>
> >
> > Also the following GridServer pages need work:
> > http://opensimulator.org/wiki/GridServer
> > <http://opensimulator.org/wiki/GridServer/ClientDocs>
> > http://opensimulator.org/wiki/GridServer/ClientDocs -
> > GridServer Client Documentation Page
> > http://opensimulator.org/wiki/GridServer/DeveloperDocs
> > <http://opensimulator.org/wiki/GridServer/ClientDocs> - GridServer
> > Developer Documentation Page
>
> I'm not sure what this is. Some of the stuff it talks about (e.g. fetching
> assets from various urls) has not been
> implemented, so I don't know if it's old or new.
>
> In general, if I were you I'd concentrate on curating pages more than
> cleaning them up. I think that making them easily
> findable in the first place will make them more likely over time to be
> either cleaned up by other people over time or
> disposed.
>
> >
> > Also where can I find out the current LSL and OSSL "Types Status" and
> > "Events Status"? Where does this information come from? Mantis? I'm
> > trying to figure out how to update those pages, but I'm just not sure
> > where the "Type Status" and "Event Status"
> > information/numbers/statistics/completion stats comes from. Please help
> > me find this information, and update the pages accordingly.
> >
> > I've updated the navigation on these pages, but please review the
> > content on all of these pages to see if the content needs to be updated
> > as well. I believe all the OpenSim "Current Status" pages need to be
> > reviewed and updated accordingly as well:
> > http://opensimulator.org/wiki/LSL_Status - LSL Status
> Page
> > http://opensimulator.org/wiki/LSL_Status/Types - LSL Types Status
> > Page
> > http://opensimulator.org/wiki/LSL_Status/Events - LSL Events
> > Status Page
> > http://opensimulator.org/wiki/LSL_Status/Types - LSL Status Page
> > http://opensimulator.org/wiki/OSSL_Status
> > <http://opensimulator.org/wiki/LSL_Status> - OSSL
> > Status Page
> > http://opensimulator.org/wiki/OSSL_Status/Types
> > <http://opensimulator.org/wiki/LSL_Status/Types> - OSSL Types
> > Status Page
> > http://opensimulator.org/wiki/OSSL_Status/Events
> > <http://opensimulator.org/wiki/LSL_Status/Events> - OSSL Events
> > Status Page
> > http://opensimulator.org/wiki/OSSL_Status/Types
> > <http://opensimulator.org/wiki/LSL_Status/Types> - OSSL Status
> Page
>
> I think much of this information stems from the days when Alondria and
> CharlieO were working on that area (neither are
> still active), though I'm sure people have updated these lists since then.
>
> I imagine that the data itself came chiefly from direct testing, ckrinke's
> paper OpenSim notebook and code inspection
> (e.g. OpenSim/Region/ScriptEngine/Shared/Api/LSL_Api.cs) and comparisons
> with lsl wiki pages.
>
> >
> >
> > Please give me some feedback, and/or update the content on the WIKI
> > pages listed above (or if you are not comfortable with updating the
> > WIKI, please just send me the correct text that should be posted on the
> > WIKI page in an E-mail off-list, and I'll copy and paste the text to the
> > WIKI page, and update any necessary formatting, grammatical corrections,
> > etc). I just need some updated content for these WIKI pages. Thank-you!
> >
> > Mark
> >
> > P.S. I'm still currently working on the OSSL pages, so please give me
> > another hour or two to finish up all the OSSL template pages before
> > adding any content or updating the OSSL pages. Thanks!
> >
> >
> > ------------------------------------------------------------------------
> >
> > _______________________________________________
> > Opensim-dev mailing list
> > Opensim-dev at lists.berlios.de
> > https://lists.berlios.de/mailman/listinfo/opensim-dev
>
> --
> justincc
> Justin Clark-Casey
> http://justincc.wordpress.com
> _______________________________________________
> Opensim-dev mailing list
> Opensim-dev at lists.berlios.de
> https://lists.berlios.de/mailman/listinfo/opensim-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://opensimulator.org/pipermail/opensim-dev/attachments/20090524/8dabc69f/attachment-0001.html>
More information about the Opensim-dev
mailing list