[sldev] Better build instructions

[Ricky]

I fully agree that the old versions should be still referenced, and that the
instructions shouldn't change too dramatically between each individual
version.

I also see your point about the ability to keep articles pointed at the old
version until the new one is ready.  But maybe I am under a wrong assumption
here, but I thought that most /new/ developers will want to pull from trunk
on the SVN.  If that assumption is true, (it was for me...) then the most
visible article should be the absolute latest.  If someone then wants to
build an older (including the mainstream/released,) client then all they
have to do is select the link to the archived edition of the instructions as
they were for that edition.

The biggest cases that I can think of against my modification of Soft's idea
are as follows:
1: If the most common new developer (see note) DOESN'T want to get the
latest edition of the code.  I don't understand why they wouldn't...  Maybe
some enlightenment for me?
2: If the build article is converted to a new set of instructions before the
old instructions are fleshed out and working.  This would make correcting
the old edition impossible, whereas separate articles would make it
possible.

The benefits as I see them for my idea are summed up as follows: (In no
particular order)
* Less distinct articles to hunt around in.
* The "default" view of the build article is the latest edition by default.
* Not having to re-work all the links to the current build article in order
to bring the new build article online.

Things in common:
* There should be an index, whether sidebar or distinct article, to all the
old editions.


So if my assumptions seem invalid, then by all means, lets make distinct
articles for each time the system changes.  But if not, then let us consider
not making the system harder to maintain.

Ricky

NOTE: The reason I only consider new developers here is because an existent
developer will ALREADY know how to work with the codebase they are working
against... :-)

NOTE2: What I mean by sidebar is a div or table set to float on the right
side of the build article.


On Fri, Jul 25, 2008 at 11:31 AM, Robin Cornelius <robin.cornelius at gmail.com
> wrote:

> Ricky wrote:
> > I whole-heartedly agre on Point 1.
> >
> > On point #2 however.. Maybe we can keep using existing pages, but add a
> > sidebar linking to the old revisions of the page where each build
> > instruction set had been completed before the change.
> >
> > This would require some discipline to keep maintained, but I think it is
> > better than cluttering the Wiki with a bunch of new pages, and having to
> > remember to update links on other pages scattered all over the wiki. :-)
> >
>
> I don't think it would generate that much page clutter, the build
> instructions are not going to change every release and i think its worth
> keeping the history of how version X was built. It would be particularly
> useful if there are large changes then its possible to start on the new
> versions as it goes through RC but keep the old ones very much up front
> to avoid user confusion.
>
> Just add an index page that links to each version.
>
> Robin
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.secondlife.com/pipermail/sldev/attachments/20080725/bf49b054/attachment.htm