Update the Wiki and Website

[jasonkliu]

See YaleSTC/reservations#532 for ideas. I've already started a jekyll page on the gh-pages branch which can be seen at http://yalestc.github.io/shifts.

• User Section: The user section should walk end users through the basic tasks of using the app. This should be hosted on the gh-pages site. These include but aren't restricted to:
  • [ ] creating a user account (CAS Login)
  • [x] starting a shift / ending a shift
  • [x] submitting payforms
  • [ ] different usage cases for student tech/other positions
  • [x] reporting issues / giving feedback
• Admin Section: The admin section should be geared towards administrators of Shifts and should be included in the README.md. It should include:
  • [x] installation / deployment of the app (including security / authentication setup)
  • [x] initial setup of application
  • [ ] user management
  • [ ] reporting
  • [ ] application settings
• Dev Section: The dev section should be geared towards developers looking to contribute to Shifts. This should be on the wiki. It should include:
  • [x] requirements
  • [x] local installation (including Ruby / Rails and database setup)
  • [x] git branching conventions (e.g. naming, git-flow, etc)
  • [x] version numbering info
  • [x] issue labeling conventions
  • [ ] milestone conventions
  • [ ] changelog conventions
  • [ ] descriptions of 3rd party tools / libraries that we use and how we use them along with any other usage notes (see existing pages and this template page)

[caseywatts]

yess >:D

[jasonkliu]

Note to self or @caseywatts or @njlxyaoxinwei:

If possible, we should have a student tech / cluster tech / etc write a description of how to use Shifts, especially with pictures. I understand how to use it from the student dev's point of view, but I believe that cluster techs and others use it differently. Also, should general info like that be on the Weke or on the Shifts github.io page?

[caseywatts]

Maybe @dgoerger and/or @mnquintana can help with this?

[mnquintana]

So ST-specific stuff should definitely be on the Weke (do CTs / MTs use the Weke?), but our public-facing instructions should be for general use.

I'll get in touch with Derek about where some of the pain points in Shifts are, and what would be mitigated with better documentation.

[dgoerger]

Agreed. Derek might also be able to give us some pointers on what to develop next, or what to prioritize once the Rails 3 upgrade ( #49 ) is complete.

All STC employees used the Weke last school year, except the Devs. I think most of the Shifts documentation can be pulled directly; we'll just need to edit out STC-specific sections such as Discipline, and proofread what we do copy, to remove references to STC. We should probably document some of the newer features (e.g. Facebook View, Email Group), and also some of the older features which many employees still don't use or understand after many years (what is a "data object"? it could literally be anything).

[caseywatts]

I copied out the STC wiki page and put it on the Dev wiki for now, so devs can access it. It's literally copy-pasted though and needs a lot of work to be generalized.

https://github.com/YaleSTC/wiki/wiki/Shifts

[mnquintana]

Would it be better to put this on the Shifts wiki?