TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Re: Git not for docs? was: Re: How do you use VMs?
Subject:Re: Git not for docs? was: Re: How do you use VMs? From:Tony Chung <tonyc -at- tonychung -dot- ca> To:TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 5 Aug 2016 12:29:18 -0700
The strength of git is lost when using binary files. Dropbox and regular
backups would be a lot better. Besides that, if the docs and code are
technically separate projects, then they should be in separate repos.
However, if the docs use files from the code then you can always create a
branch of the main line to work on, and merge back before release. Then
your doc changes can be prioritized when you merge back.
-Tony
On Friday, 5 August 2016, Julie Stickler <jstickler -at- gmail -dot- com> wrote:
> At a previous job I had a Word doc stored in Git that wasn't corrupted per
> se, but that suddenly had many, many paragraphs appearing in the wrong
> place. I suspect that a developer didn't realize that both docs and code
> lived in the same repo and did a merge. At the time I was brand new to Git
> and didn't yet know how to revert to the previous version, so finding all
> the moved paragraphs and fixing that doc was a painful process.
>
> Best practice, set up a separate repository for your docs that is separate
> from the code repos and talk to your build engineer about writing the build
> scripts to pull your docs into the builds if necessary.
>
>
> Looking for the archived Techwr-l email discussions? Search our public
> email archives @ http://techwr-l.com/archives
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com