Skip to content

Instantly share code, notes, and snippets.

@rpattabi
Created April 25, 2012 18:28
Show Gist options
  • Save rpattabi/2491951 to your computer and use it in GitHub Desktop.
Save rpattabi/2491951 to your computer and use it in GitHub Desktop.
distributed version control for magazine project (scribus files, images, text)
************************************************************
This is an analysis of using version control system for magazine creation project.
# Use case:
The source contains scribus files, and images which are not mergeable
More than one person should be able to access the files
At any time, the latest version should be available for anyone.
People should not lose their work since they started working with old files.
People should be able to take work to home without the need to have access to central server.
The workflow should be simple to understand and follow.
The people who work on the project are a few (at max 5).
They are well connected through email, phone, and IM (skype).
The set of files are not huge. Just a small directory with 100 files at the max.
These people are only used to windows. UI should be simple.
This is not their main work. Whenever they get a chance they will contribute to this.
************************************************************
DVCS is suitable since it presents a simple to understand source control approach. Its all about getting latest, working on the files without worryng about checking out or locking, once done commit locally, and when possible push to master. Should be simple.
git also has tortoise git which works with windows explorer. This might help the typical windows users to use it easily.
A central repository is necessary as that might be where everyone can look for the latest. After some trial, we have to see the actual use to find if central repository is really necessary and the well connected team can manage the latest vesion themselves.
In order to deal with the binary or non mergeable files, better source structure is recommended. Of course team has to communicate priorto update of any of these files.
folder: root
folder: cover
file: background.png
file: content.scribus
file: magazine_logo.svg
file: company_logo.svg/png
folder: editorial
file: content.txt
file: author.png
file: background.png
file: editorial.scribus
folder: contents
file: contents.scribus
file: background.png
file: article1.thumb
file: article2.thumb
folder: article1
file: background.png
file: content.scribus
file: content.txt
file: author.png
file: content.png
file: content_1.png
With this structure, merging of files may not be required at all. Team members should be instructed to inform the team prior to working on any of the folders/pages of the magazine.
The common stuff for all the pages can be kept in a different folder. For example, header, footer, page number design can be kept in a template/master page in one folder. These can be applied at the end of the rest of the things.
==
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment