Documentation

Best practices for upgrading Drupal (6->7) and CiviCRM (3->4) at the same time

Published
2013-04-11 12:16
Written by

The attached chart came out of a discussion between Kasia Wakarecy, Lola Slade and myself (Lynna Landstreet), at Freeform Solutions, about some issues we'd encountered when trying to to do major version upgrades of CiviCRM and Drupal on a client's site at the same time. Since we're likely to have a number of other combined upgrades like that to do in the future, we wanted to iron out the best process for doing them as smoothly as possible.

Quick Tool for Upgrading Custom Templates

Published
2012-12-03 16:21
Written by

Do you modify template files for your site?  If so, you ought to know the tedious process of updating all the overridden template files every time you upgrade.  (If you don't know that pain, either you've never upgraded or you should quit reading and go check your customized files.)

ERD for CiviCase version 3.3

Published
2012-11-20 00:50
Written by

Just created a quick ERD for CiviCase, and shared it on this page http://wiki.civicrm.org/confluence/display/CRMDOC42/CiviCRM+ERD+3.3.

It is version 3.3, so not the latest and greatest. But I am sure I will have to check the same ERD for version 4 at a near point in the future and update the ERD too. And I do not think there are major differences in the data model......

I have also attached the ERD to this blog post.

Mining the Wiki

Published
2012-04-04 15:34
Written by

We're at the book and documentation sprint out at the very lovely Woolman Centre near Nevada city in California. A sub group of us have taken on the mighty task of analysing how the wiki content sits with the book content. We're focusing on the User and Administrator guide at the moment, which is online at http://book.civicrm.org/user/.

 

New 'minor version' of the books up at book.civicrm.org

Published
2012-03-02 11:33
Written by

We're wrapping up the London code sprint today. We've done a decent amount of book review, which will stand us in good stead when we get to Woolman and we've also made some minor improvements to the books at book.civicrm.org.

Books now have a 'breadcrumb' which show you what section you are reading and they also have proper titles, which should make them more visible when people are googling for help.

It would be great to hear other ideas for improving the publication process.

Plans for London documentation sprint

Published
2012-02-28 04:46
Written by

We're doing a fair amount of work on the book review at the London sprint. It would be cool to have others involved (remotely or in person).  If you want to help out then

  • come along to CAN Mezzanine (let us know if you are coming) or
  • jump on IRC and say hello (during London friendly hours) or
  • subscribe to the book list and send us an email.

The best places to start and orient yourself are:

Books on civicrm.org

Published
2011-12-17 03:22
Written by

For the past couple of years (since May 2009) we've used Flossmanuals to write our CiviCRM books. In August this year, our old faithful Comprehensive guide to CiviCRM became two: The CiviCRM user and administrator guide and The CiviCRM developer guide. The user and administrator guide is now in its fourth version and we're currently writing new training guides for administrators and developers. We are also experimenting with sector specific introductions and it feels like we are headed towards a pretty comprehensive set of documentation for CiviCRM.