CiviCRM Community Forums (archive)

*

News:

Have a question about CiviCRM?
Get it answered quickly at the new
CiviCRM Stack Exchange Q+A site

This forum was archived on 25 November 2017. Learn more.
How to get involved.
What to do if you think you've found a bug.



  • CiviCRM Community Forums (archive) »
  • Old sections (read-only, deprecated) »
  • Discussion (deprecated) »
  • Documentation, Book and Training Resources (Moderator: Michał Mach) »
  • Developing docs in our own Confluence wiki - challenges
Pages: [1]

Author Topic: Developing docs in our own Confluence wiki - challenges  (Read 3596 times)

Andy Laken

  • I’m new here
  • *
  • Posts: 27
  • Karma: 3
Developing docs in our own Confluence wiki - challenges
June 12, 2007, 03:38:52 pm
We're preparing to roll out a customized implementation of CiviCRM to several of our partner organizations. We're writing our own documentation to cover our customizations – since our end-users are not technical we feel a turnkey, customized documentation site is the way to go, rather than separately maintaining docs on our customizations in one place and referring them to wiki.civicrm.org for the basics. We've secured a Confluence license so we can start with the existing docs for our efforts.

Today Dave G was kind enough to provide a Confluence space export of section 4 (end user's guide) to get us started. But we have a technical problem: we're running the latest release of Confluence, v 2.5.3, while wiki.civicrm.org runs v 2.1.4. Confluence only supports Forward Compatibility and Backward Compatibility for individual space import and export when executed within the same major version of Confluence instances, i.e. a space export from v 2.1.4 can only be imported into another installation of v 2.1.x. Running the latest version, we're unable to import the file Dave sent.

Confluence does support backward compatibility of an entire site export across major versions, meaning if Dave exported the entire wiki.CiviCRM.org Confluence site, then we could import it. This enables a workaround, but it's laborious:  you create a separate "scratch" install of the later version alongside your live site. You then do the entire site import from the previous version into the scratch install. Now, with both sites at v 2.5.3, you can do a space export on the portion you want, and import it into your live install.

This limitation and workaround are documented here: http://confluence.atlassian.com/display/DOC/Restoring+a+Space

This workaround might be feasible to do a 1-time transfer to get us started, but the whole point of us using Confluence was to be able to easily merge in updates to the main CiviCRM docs, as well as easily contribute back to the main docs pages we write that are applicable to stock CiviCRM.

In order to achieve these goal it seems we have these options:

  • We downgrade our Confluence to the 2.1 branch (if that's even possible)
  • wiki.civicrm.org upgrades Confluence to 2.5 branch (please? maybe?  :) )
  • We could conceivably dispense with our own Confluence installation altogether if CiviCRM would be willing to let us have a private space on wiki.civicrm.org to develop and maintain our custom documentation for our users. Is this even a remote possibility?


Anyone have some ideas?

I want to emphasize that we have a staff member with experience in technical writing who is spending a significant amount of her time creating documentation – this will likely result in some valuable documentation resources we'd love to contribute back to the main docs, if we can overcome these technical hurdles.

We're also interested in having a conversation on how best to keep updates to the main docs in sync with our docs.

Thanks!
Andy Laken
Engineer | CivicActions, LLC
e: andy.laken@civicactions.com | skype: mcantsin | http://twitter.com/alaken

Donald Lobo

  • Administrator
  • I’m (like) Lobo ;)
  • *****
  • Posts: 15963
  • Karma: 470
    • CiviCRM site
  • CiviCRM version: 4.2+
  • CMS version: Drupal 7, Joomla 2.5+
  • MySQL version: 5.5.x
  • PHP version: 5.4.x
Re: Developing docs in our own Confluence wiki - challenges
June 12, 2007, 03:52:54 pm

Andy:

awesome news on the documentation front :). We definitely are latest version junkies in most cases. We'd love to upgrade to the latest version of Confluence, BUT (u knew there had to be but clause in there) a few issues have made it incredibly hard which we need to resolve soon. Now is as good a time as anything :)

a. As you know confluence / jira / fisheye etc are java based programs and the new versions require a recent version of java (java 5 i think, yes not very recent, i know!).

b. you need a fairly stable java stack to run the above. Our server however are running freebsd right now (since our hosting provider electric embers only uses and supports freebsd. In our opinion, FreeBSD does not have a stable java stack and/or we do not know how to install and have a stable version of the latest confluence on freebsd. Michal has spent a fair amount of time trying to get this working with no success and has given up. If some adventurous FreeBSD sys admin wants to give this another go, please contact us offline.

c. we've made the decision to move to a ubuntu based linux machine sometime this year (v2.0 perhaps). However we can do it earlier if needed, but there is an issue of resources, time and $$$ involved (and we are a bit strapped with all 3 right now).

d. For the short term, we could host you on our wiki as a separate space and as we move up the release cycle we can keep u'll in sync / fork you'll over to your license. Better yet, maybe u, dgg and john k could have a melting of minds and figure out how to keep your changes (both documentation and code changes) in the main code base. A fork in general is not beneficial in the long term and merging is always harder than imagined.

lobo
 
A new CiviCRM Q&A resource needs YOUR help to get started. Visit our StackExchange proposed site, sign up and vote on 5 questions

Dave Greenberg

  • Administrator
  • I’m (like) Lobo ;)
  • *****
  • Posts: 5760
  • Karma: 226
    • My CiviCRM Blog
Re: Developing docs in our own Confluence wiki - challenges
June 12, 2007, 10:14:39 pm
Andy - I think it would be worthwhile for us to have a synchronous chat (skype or phone) to discuss your goals and brainstorm on some alternatives. Perhaps you can email me some times that would work in the next day or so.
Protect your investment in CiviCRM by  becoming a Member!

Pages: [1]
  • CiviCRM Community Forums (archive) »
  • Old sections (read-only, deprecated) »
  • Discussion (deprecated) »
  • Documentation, Book and Training Resources (Moderator: Michał Mach) »
  • Developing docs in our own Confluence wiki - challenges

This forum was archived on 2017-11-26.