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) »
  • Versioned documentation
Pages: [1]

Author Topic: Versioned documentation  (Read 5339 times)

mfb

  • Guest
Versioned documentation
August 29, 2008, 05:36:31 pm
The CiviCRM APIs and data model are changing with each version, so we really need versioned documentation, similar to what's available at http://api.drupal.org/ for Drupal 5.x, 6.x, etc.

For example http://wiki.civicrm.org/confluence/display/CRMDOC/Custom+Data+Group+and+Custom+Field+APIs is being updated for v2.1, such as the removal of the domain_id parameter.  The only way for developers to get the docs for v2.0 is to look at older versions of the page.

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: Versioned documentation
August 29, 2008, 06:04:49 pm

maybe an easier short term way around this is to create a v2.0 API page and get it to point to the specific revisions of the API. That way we dont change the documentation process but just need to create one page for a version and ensure it points to the right revisions etc

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

mfb

  • Guest
Re: Versioned documentation
August 29, 2008, 06:11:31 pm
If you mean pointing to old revisions of API doc pages, I don't think that would be a good solution.  Every time we correct or flesh out a v2.0 page we'd have to go back to the main 2.0 page and change the link.

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: Versioned documentation
August 29, 2008, 06:17:45 pm

you might want to search on the confluence web site and see if they are any add-ons that we can potentially use for this purpose that meets the needs / requirements

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

mfb

  • Guest
Re: Versioned documentation
August 29, 2008, 06:34:27 pm
The Confluence docs setup seems pretty good: http://confluence.atlassian.com/display/DOC/Confluence+Documentation+Home
From the main page you can get to docs for older versions.  I'm kind of assuming this is just using the built-in "spaces" functionality not any add-on?

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: Versioned documentation
August 29, 2008, 08:58:15 pm

we'd be happy to give you wiki admin access if you are willing to research and figure out how confluence does it on their web site and how we could do it going forward. I'm not sure how easy it will be to do this retroactively :)

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

mfb

  • Guest
Re: Versioned documentation
August 30, 2008, 05:09:32 pm
I posted a question on their forums to see if they have a write-up on their documentation (aka meta-documentation). 

There is wiki markup available for their docs in case that helps at all: http://confluence.atlassian.com/pages/viewpagesrc.action?pageId=135922

Michał Mach

  • Ask me questions
  • ****
  • Posts: 748
  • Karma: 59
    • CiviCRM site
  • CiviCRM version: latest
  • CMS version: Drupal and Joomla latest
  • MySQL version: numerous
  • PHP version: 5.3 and 5.2
Re: Versioned documentation
September 02, 2008, 04:01:42 am
Hey,

I took a look at Confluence documentation home and it seems like their procedure is based on making a copy of whole space whenever new version appears and applying version relevant changes to it space copy. It would require introducing some new workflow on releasing new versions - we'll discuss it and come back to conversation on this thread.

Thx,
m
Found this reply helpful? Contribute NOW and help us improve CiviCRM with the Make it Happen! initiative.

My absolute favourite: Wordpress Integration!.

Donate Now!

mfb

  • Guest
Re: Versioned documentation
September 02, 2008, 01:40:41 pm
Quote from: Michał Mach on September 02, 2008, 04:01:42 am
I took a look at Confluence documentation home and it seems like their procedure is based on making a copy of whole space whenever new version appears and applying version relevant changes to it space copy.

Yes, there's a good little writeup here on how they do it: http://forums.atlassian.com/message.jspa?messageID=257288301
Pages: [1]
  • CiviCRM Community Forums (archive) »
  • Old sections (read-only, deprecated) »
  • Discussion (deprecated) »
  • Documentation, Book and Training Resources (Moderator: Michał Mach) »
  • Versioned documentation

This forum was archived on 2017-11-26.