[cle-release-team] 2.9 install guide totally incorrect

[Steve Swinsburg]

Yep I think the Maven Goal Options is unnecessary. Maven is so prolific
these days, we dont need to teach people how to use it.

I also think we should:

Slim down the install Java and install Subversion parts. Again, we require
them, but dont need a full on install guide for them. Just stating the
versions is sufficient. There are package installers which do everything,
and 99% of systems have them already.

Also, the part about downloading the source via SVN come before the SVN
install section.

Remove 4.2 (its done automatically by Maven)

Remove 4.3

Slim down Tomcat install. Just say Tomcat 7 is required. The env vars are
not strictly required, they can be part of the startup.

Remove part about '1.4 Compatibility package'.

5.2 needs to include the additional Tomcat settings and have the part about
index.html removed (also unnecessary).

Remove 5.4

That should be pretty slim and more effective IMO.

cheers,
Steve




On Thu, Jan 3, 2013 at 3:20 AM, Neal Caidin
<nealcaidin at sakaifoundation.org>wrote:

> The maven clean install is in section 7 of the install guide already, so I
> guess you are saying to just delete section 4.3 ?
>
> As far as the URL goes, both of these work:
>
> https://confluence.sakaiproject.org/pages/viewpage.action?pageId=82249316
>
>
> https://confluence.sakaiproject.org/display/DOC/Sakai+CLE+2.9+install+guide+(source)
>
> Maybe there is a better way? But at least the 2nd option is closer to what
> you are talking about.
>
> -- Neal
>
>
>
> On Dec 31, 2012, at 5:31 PM, Steve Swinsburg <steve.swinsburg at gmail.com>
> wrote:
>
> I would suggest removing the reference to the settings.xml file, its
> unnecessary and just makes the install more complicated.
> Replace it with
> mvn clean install sakai:deploy -Dmaven.tomcat.home=/path/to/tomcat
>
> if people want to make advanced maven config on a system, that is there
> prerogative. Our install guide should be short and sweet, not comprehensive
> to cater for everyones use case.
>
> Also, on the URLs, why cant we have
> confluence.sakaiproject.org/DOC/Install Guide - 2.9 (or similar)? Why is
> it some obtuse pageId?
>
> Happy new year all, a new year of making things easier for the people!
>
> cheers,
> S
>
>
> On Tue, Jan 1, 2013 at 2:56 AM, Neal Caidin <
> nealcaidin at sakaifoundation.org> wrote:
>
>> This page needs updating -
>> https://confluence.sakaiproject.org/pages/viewpage.action?pageId=69273826 - Tomcat Windows Service (2.x)  - references Tomcat 5.5
>>
>> I realize most folks are probably still on holiday.  I'll start compiling
>> these in a Google doc and bring up at a CLE release team meeting. Ideally,
>> we would have a CLE release team member review the docs from end-to-end (or
>> split that task up among a few CLE members). I could imagine having folks
>> take a look for obvious errors, but then it would also be nice to have the
>> documents tested, follow the instructions and see the results. I know, lots
>> of work. What can we bribe folks with? ;-)
>>
>> -- Neal
>>
>>
>>
>> On Dec 31, 2012, at 10:05 AM, Neal Caidin <nealcaidin at sakaifoundation.org>
>> wrote:
>>
>> Specific things that need validation on
>> https://confluence.sakaiproject.org/pages/viewpage.action?pageId=81756286
>>
>> * Section 2.1 - Additional required settings under  Set Java_Opts
>> reference Tomcat 5.5
>> * Section 4.3 Create a Maven settings.xml file .  I thought this had been
>> reviewed but seeing a reference to tomcat5x
>>
>> Any volunteers?
>>
>> Cheers
>>
>>
>> On Dec 31, 2012, at 8:27 AM, Steve Swinsburg <steve.swinsburg at gmail.com>
>> wrote:
>>
>> G'day Neal,
>> First hit in google for 'Sakai install guide' comes up with the source
>> install (2.9) page:
>>
>> https://confluence.sakaiproject.org/pages/viewpage.action?pageId=81756286
>>
>> Sent from my iPhone
>>
>> On 31/12/2012, at 23:49, Neal Caidin <nealcaidin at sakaifoundation.org>
>> wrote:
>>
>> Hi Steve,
>>
>> What path are you looking at?
>>
>> 1) When I go to the overall release notes page -
>> https://confluence.sakaiproject.org/display/DOC/Sakai+CLE+2.9+release+notes
>>
>> 2) Then find "installing" and expand it's display
>>
>> 3) Then click on "Sakai CLE 2.9 install guide (source)"
>>
>> I'm seeing Tomcat 7, Maven 3, etc.
>>
>> Thanks,
>> Neal
>>
>>
>> On Dec 30, 2012, at 6:12 AM, Steve Swinsburg <steve.swinsburg at gmail.com>
>> wrote:
>>
>> I just had to grab something from the install guide and noticed it is
>> totally incorrect. It looks like its been copied from the 2.7 one? Why not
>> the 2.8 one? It still references Maven 2.0, Tomcat 5.5, Sakai 2.7 code. I
>> hope no one has tried to use it.
>>
>>
>> This needs to be updated as a matter of urgency and should have been
>> ready before the 2.9.0 release went out...
>>
>>
>> I also think its far too long winded. You don't need a maven settings
>> file, nor to help people configure tomcat with the sub standard index.html
>> file in the ROOT webapp, or to show them how to install Tomcat as a
>> service, or even the various flags for Maven. That's all just junk that
>> gets in the way and makes us look like amateurs. If people want that stuff
>> they can look up the up to date info elsewhere.
>>
>>
>> The install guide should have:
>>
>>
>> Setup the apps you need.
>>
>> Download source
>>
>> Build
>>
>> Start tomcat
>>
>> Fin.
>>
>>
>> thanks,
>>
>> Steve
>>
>>
>> _______________________________________________
>>
>> cle-release-team mailing list
>>
>> cle-release-team at collab.sakaiproject.org
>>
>> http://collab.sakaiproject.org/mailman/listinfo/cle-release-team
>>
>>
>>
>>
>>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://collab.sakaiproject.org/pipermail/cle-release-team/attachments/20130103/2ff70157/attachment-0006.html