Ticket #2535 (new defect)

Opened 8 months ago

Last modified 8 months ago

Update tutorials to use BlackCandy instead of tutorial theme

Reported by: wrossiter Owned by: wrossiter
Priority: medium Milestone:
Component: Documentation Version:
Severity: medium effort / impact Keywords:
Cc: Hours:

Description (last modified by wrossiter) (diff)

Update the SilverStripe? tutorial 1 and tutorial 2 to use BlackCandy? rather then the old theme. Also I note there is some SS 2.1 CMS screenshots too. Will update... Oh darn just seen that the first 4 themes all use the tutorial theme.. Got to update those as well! Fun times!!

Also take the time to remove old content re the windows installer and add new /common process's like installing themes / modules.

Need to remove the code on how to create / add menus as BC already includes all this but this is probably a good place to cover some of the basics so it should explain the main components of the Theme - eg Controls (menus), $Varibles like $Title.

First tutorial

- Installation

  • Link to individual installation pages - win, osx, linux / server requirements etc etc
  • Common Issues - Link
  • Overview of folders/ files / projects

- Overview of the CMS

  • Creating Pages/ etc. Pretty similar as current

- Installing Modules, Themes, Widgets

  • Brief info explaining - link out to full pages

- Overview of the SS templates

  • Controls $Variables structure. Explain Menus, Built in Page Controls

- Custom Page Types

  • Homepage, Creating Code and Separate Templates

- Where to go Next

  • Tutorial 2 - Extending
  • Tutorial 3
  • Helpful links
    • Forum

Tutorial 2

I dont know but I think the ArticleHolder/Page? current example could be dropped in favour of 1 more in depth version based on the current Staff page example since with news many people might be just using the blog module.

I would expand the staff example so each staff member had (for example looking at the forum for most common issues, questions that are pretty basic) - Staff

  • Photo - example of using has_one relation and image field - starts to tie into GD and image tools
  • DateOfBirth? - example of using a 'Date' Field - Good example of $Date.Nice Functions and how to use those sort of methods
  • Quote - Example of using a Second TinyMCE field, HTMLEditor. Adding fields to tab.

We would also explain the StaffHolder? -> StaffPage? Datamodel relationship etc stuff. Then in the templates all about how to render Pics, Date etc etc.

This pretty much covers what we currently have with the 2 examples into 1 example which I think is easier to follow for a beginner and we can walk through the process a bit more in depth

Also I think since we dont cover Creating a theme in the first tutorial I think we can start talking about that

Tutorial 3 I think its good, even though we now have a polls module :P How to make a poll is a good introduction to forms (I still refer to it if) If no one has a better example for the form example I think we should stick with the idea of a poll as the form rather then a massive rewrite. Ideas?

Tutorial 4 - Sam, Sig has added me a ticket to add a search as a default feature of BlackCandy? which Is probably a good idea. If I do that would a Search Tutorial be necessary or excessive? - It is a good example of using DataObjectSets? and does cover some good ideas. Perhaps I leave search out of BC by default and use the tutorial, just include the CSS for it by default so users only need to follow the PHP and HTML in the tutorial

Tutorial 5+ Uses BC so I dont have to do anything!

Let me know what you think and any thoughts, points you might have!

Change History

Changed 8 months ago by wrossiter

  • description modified (diff)
  • summary changed from Update tutorial 1 and 2 to use BlackCandy instead of tutorial theme to Update tutorials to use BlackCandy instead of tutorial theme
Note: See TracTickets for help on using tickets.