[sakai-pmc] Revising/trimming Sakai developer and install documentation
matthew.buckett at it.ox.ac.uk
Tue Jan 6 02:43:53 PST 2015
I'm all for having a README.md that tells people how to get going in the
simplest and most failsafe way.
Would also be good to have a CONTRIBUTING.md that lists how we expect
people to work with github as when your creating a pull request github will
prompt you to look at the CONTRIBUTING.md file to check you're working in
the right way.
On Tue Jan 06 2015 at 10:37:49 AM Steve Swinsburg <steve.swinsburg at gmail.com>
> Hi all,
> Now that Sakai is up on github, I wonder if its a good time to have a
> think about the complexity of the developer and installation documentation
> and trim it massively so it's just the essential steps.
> I strongly feel that the days of hand holding people through installing
> third party software are gone. Those sites generally do a good job
> themselves. If it's Sakai specific then we describe it, if it's not then we
> just say, Install Tomcat 7 (for example).
> This page is a classic example of being far too verbose:
> It would be ideal if the simplest instructions to get up and running are
> put into the readme and then the rest of the doco trimmed and migrated to
> something like https://pages.github.com/
> sakai-pmc mailing list
> sakai-pmc at collab.sakaiproject.org
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the sakai-pmc