[sakai-core-team] Github pages - training?

[Earle Nietzel]

I think we should embrace githubs documentation and at least have some
documentation on github, (links to things in confluence would be nice
as well).

Short of the documentation project I think the main sakai repo should
contain a README.md for each project and one for the top level that
explains the basics of getting started.

I just havn't had the time to work on this lately, but I do have a
Github presentation at the conference that I will be covering this in
that presentation.

I would love if someone had the same vision and wanted to team up!!!


On Tue, Mar 31, 2015 at 9:56 AM, Matthew Jones <matthew at longsight.com> wrote:
> Yeah, I'm not 100% sure what you mean either, Neah,
>
> For a few of the PR's that have come in, I've suggested that we start a
> documentation that mentions special configuration (like tool properties
> which we currently don't have any place for) or anything else. One example
> is the README.md documentation in user that Brian did to support that.
>
> https://github.com/sakaiproject/sakai/tree/master/user
>
> Also Lessons has a large documentation page
> https://github.com/sakaiproject/sakai/tree/master/lessonbuilder
>
> I think it would be convenient if every tool had a documentation page. Earle
> had talked about getting a basic template setup in each directory, but it
> would take some work to have someone either pull info over from confluence
> or have a developer fill them out. Some of these are already better
> documented in confluence (sitestats, profile2, search) some of them have
> hardly any docs. But even if they are documented over there I think it's
> hard to find. I think either pulling that confluence over to a README.md and
> having that the authoritative source, or at minimal a link to the confluence
> page from github would be nice.
>
> There is a https://github.com/sakaiproject/sakai-documentation repository,
> but I don't know anything about the goals of that.
>
> On Tue, Mar 31, 2015 at 8:50 AM, Kirschner, Beth <bkirschn at umich.edu> wrote:
>>
>> Hi Neal,
>>
>> I guess I'm uncertain of what the vision is to use GitHub for
>> documentation -- were you thinking of release documentation? Leveraging
>> GitHub wiki pages perhaps? Here's a good starting point:
>>         https://help.github.com/articles/about-github-wikis/
>>
>> - Beth
>>
>> On Mar 30, 2015, at 4:13 PM, Neal Caidin <neal.caidin at apereo.org> wrote:
>>
>> > Hi Sakai Core team,
>> >
>> > It's been mentioned a couple of times, I think, that Github pages might
>> > be a great resource for us to use to publish certain types of documentation.
>> >
>> > Does anybody have experience with it and willing to share 30 minutes
>> > with me to provide an overview of how it works and how we could use it with
>> > Sakai?
>> >
>> > Thanks,
>> > Neal
>> >
>> > _______________________________________________
>> > sakai-core-team mailing list
>> > sakai-core-team at collab.sakaiproject.org
>> > http://collab.sakaiproject.org/mailman/listinfo/sakai-core-team
>>
>> _______________________________________________
>> sakai-core-team mailing list
>> sakai-core-team at collab.sakaiproject.org
>> http://collab.sakaiproject.org/mailman/listinfo/sakai-core-team
>
>
>
> _______________________________________________
> sakai-core-team mailing list
> sakai-core-team at collab.sakaiproject.org
> http://collab.sakaiproject.org/mailman/listinfo/sakai-core-team
>



-- 
earle,
asahi net int.