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) »
  • Developer Discussion (Moderator: Donald Lobo) »
  • Split Developer Documentation wiki into different space
Pages: [1]

Author Topic: Split Developer Documentation wiki into different space  (Read 493 times)

JoeMurray

  • Administrator
  • Ask me questions
  • *****
  • Posts: 578
  • Karma: 24
    • JMA Consulting
  • CiviCRM version: 4.4 and 4.5 (as of Nov 2014)
  • CMS version: Drupal, WordPress, Joomla
  • MySQL version: MySQL 5.5, 5.6, MariaDB 10.0 (as of Nov 2014)
Split Developer Documentation wiki into different space
June 15, 2015, 12:38:59 pm
The wiki has nice features for filtering results by space. To be able to get just developer documentation easily returned by a search, it would be convenient to have it in its own space. Do this might require some additional work, however, eg versioning both the developer and user documentation spaces which means creating a new copy of each each release. Would there be much other additional work? If not, could we make this change?
Co-author of Using CiviCRM https://www.packtpub.com/using-civicrm/book

totten

  • Administrator
  • Ask me questions
  • *****
  • Posts: 695
  • Karma: 64
Re: Split Developer Documentation wiki into different space
June 15, 2015, 01:09:32 pm
I'm not enough of a Confluence expert to comment on rearranging spaces, but on a related topic...

Michael has been making some moves toward putting the User/Admin Guide in git. This is appealing to me from the perspective of maintaining developers' reference material (like the Developer Guide and the "Xxx Reference" wiki pages). Tracking reference material in git means that versioning/branching/merging works the same for code+docs (tags/branches) and enables atomic updates (ie one PR which simultaneously changes code and ref-docs).

https://civicrm.org/blogs/michael-mcandrew/moving-civicrms-user-and-administrator-guide-gitbook-or-readthedocs

That's not to say git should replace everything that the wiki does (eg roadmap/design/spec materials may be produced in collaboration with non-devs, and they may not need the bureaucracy of pull-requests), but I wonder how you/others would feel about migrating developer docs to git rather than another wiki-space.

JoeMurray

  • Administrator
  • Ask me questions
  • *****
  • Posts: 578
  • Karma: 24
    • JMA Consulting
  • CiviCRM version: 4.4 and 4.5 (as of Nov 2014)
  • CMS version: Drupal, WordPress, Joomla
  • MySQL version: MySQL 5.5, 5.6, MariaDB 10.0 (as of Nov 2014)
Re: Split Developer Documentation wiki into different space
June 15, 2015, 01:17:55 pm
I like the idea at a high level, even though it will be slightly less convenient for me personally.

For certain purposes, the ability to display Mockup images inline is important, or .pngs, and to have them readily linked to the bmml files. I guess we could change our workflow when developing specs to use comments on PRs/commits rather than at the bottom of a page.
Co-author of Using CiviCRM https://www.packtpub.com/using-civicrm/book

totten

  • Administrator
  • Ask me questions
  • *****
  • Posts: 695
  • Karma: 64
Re: Split Developer Documentation wiki into different space
June 15, 2015, 01:30:58 pm
Agree that it's really nice to have mockups and comments when working on plans/specs/scratchsheets. FWIW, plans/specs are already placed in a separate space from user+developer docs (CRM vs CRMDOC).

(Aside: I'm only advocating a move for developer docs/reference. For plans/specs/scratchsheets, I don't have any complaints about the current system using the CRM space.)

Coleman Watts

  • Administrator
  • I’m (like) Lobo ;)
  • *****
  • Posts: 2346
  • Karma: 183
  • CiviCRM version: The Bleeding Edge
  • CMS version: Various
Re: Split Developer Documentation wiki into different space
June 15, 2015, 01:34:36 pm
I like the idea of putting developer docs under version control. They were originally on booki, then moved to the wiki to be more easily editable. A gitbook sounds like the best of both.
Try asking your question on the new CiviCRM help site.
Pages: [1]
  • CiviCRM Community Forums (archive) »
  • Old sections (read-only, deprecated) »
  • Developer Discussion (Moderator: Donald Lobo) »
  • Split Developer Documentation wiki into different space

This forum was archived on 2017-11-26.