Using GIT and bitbucket processes to review DITA content changes

[Deb D]

Hi,

  I'm interested in using Git and BitBucket to manage the review process of changes to my dita files.  The Developers in my org already use and are familiar with both apps to perform code reviews.  I have my dita files in git and add the list of reviewers to my pull  request.  Things work quite nicely with one exception, the content of the conkeyrefs do not appear in the dita file, only the link.  I know this is kind of expected. Right now, for any content changes that contain conkeyrefs, I produce a PDF file so the reviewers can see all the content.  Any other ideas?  What tools do people use to review doc changes?  

Thanks

Debbie

[Ron Wheeler]

I suspect that in many cases, end-users are going to be most comfortable with your approach as opposed to a more technically correct method that requires them to imagine how  the topics under review will actually appear in documents.

How much reuse is there of your topics?
If you are only actually producing a small number of documents, people may be most comfortable reviewing the intended outputs. This has the advantage of also detecting issues with map files as well as content questions. The downside is that you may also have to provide the git history to help reviewers focus on the changes since the last review.
This puts an onus on the editors to create useful comments when committing changes which is not a bad thing!

Ron

--
You received this message because you are subscribed to the Google Groups "DITA-OT Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to dita-ot-user...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Stefan Eike]

Hi Debbie,

reviewing the plain XML files is a pain for your reviewers. You are looking for oXygen Content Fusion. You will love it.

Stefan

[Radu Coravu]

Hi Debbie,

As a disclaimer I work for Oxygen XML Editor.

Our WebAuthor online DITA editing tool can open content directly from BitBucket and when opening a topic you can pass to it a reference to the main DITA Map so that it expands conkeyrefs, shows link with keyref titles and so on:

https://www.oxygenxml.com/oxygen-xml-web-author/app/oxygen.html

Or if you are already using Oxygen XML Editor to edit the DITA content and want informal collaboration (get feedback before committing the content to the Git Repository) indeed as Stefan said our oXygen Content Fusion plugin might be an option:

https://www.oxygenxml.com/content_fusion/take_a_tour.html

Regards,

Radu

--

[Deb D]

Hi,

 It looks like my post never made it.  After a few trial runs, I ended up using git and bitbucket for the review process. The feedback I received from the reviewers was pretty positive, which I wasn't expecting.  We are a startup so using existing tools is the preference right now.  We do use Oxygen Editor  and I'm hoping down the road we can move to a different content management and reviewing solution.  

  Thanks very much for the feedback from everyone, I appreciate it.

Debbie