From 6509f859a95ff3256c05a2b336bcb8f5bbcfc98b Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Jun 10 2013 17:06:54 +0000 Subject: Update Tcar-ug documentation manual. --- diff --git a/Documentation/Models/Docbook/Tcar-ug/Repository/Convenctions/layout.docbook b/Documentation/Models/Docbook/Tcar-ug/Repository/Convenctions/layout.docbook index 6a28b47..e651a73 100644 --- a/Documentation/Models/Docbook/Tcar-ug/Repository/Convenctions/layout.docbook +++ b/Documentation/Models/Docbook/Tcar-ug/Repository/Convenctions/layout.docbook @@ -3,33 +3,67 @@ Repository Layout - &TCAR; is supported by Subversion, a - version control system which allows you to keep old versions + &TCAR; is made of one central repository and + many working copies of that central repository. + The working copies are independent one another, can be + distributed all around the world and provide a local place for + designers, documenters, translators and programmers to perform + their work in a decentralized way. The central repository, on + the other hand, provides a common place for all independent + working copies to interchange data in the community. + + + + The current infrastructure that holds &TCAR; is supported by + Subversion, + a version control system which allows you to keep old versions of files and directories (usually source code), keep a log of who, when, and why changes occurred, etc., like CVS, RCS or - SCCS. + SCCS and Trac, + a web-based software project management and bug/issue tracking + system emphasizing ease of use and low ceremony. - &TCAR; is made of one source repository and - many working copies of that source repository. - The working copies are independent one another, can be - distributed all around the world and provide a local place for - designers, documentors, translators and programmers to perform - their work in a descentralized way. The source repository, on - the other hand, provides a central place for all independent - working copies to interchange data and provides the - information required to permit extracting previous versions of - files at any time. + In addition to current Subversion infrastructure, we are + working on a Git infrastructure with the intention of + migrating the central repository to it, progressively. Here we + use Gitolite to manage Git repositories, Gitweb to make + changes browsable through the web and Mantis to track + repository issues. The main reason for this migration is to + take advantage of distributed version control system inside + &TCAR;. It also let people to commit changes locally, without + any network access, and later push local commits up to central + repository, when the network access be re-established. This + could be very useful in very different kind of situations. +
+ Subversion + - The first level of directories inside &TCAR; provides + In this layout, the first level of directories inside &TCAR; + provides the Subversion's standard trunk-branches-tags layout. + The second level of directories provides organization for + different work lines, as described in . All other subsequent + directory levels from second level + on exist to organize specific concepts related to the work + line they belong to. + + +
+ +
+ Git + + In this layout, the first level of directories provides organization for different work lines, as described in . All other subsequent - directory levels from third level on exist to organize + directory levels from second level on exist to organize specific concepts related to the work line they belong to. +
+ diff --git a/Documentation/Models/Docbook/Tcar-ug/Repository/History/2012.docbook b/Documentation/Models/Docbook/Tcar-ug/Repository/History/2012.docbook index 28b8fae..cf81287 100644 --- a/Documentation/Models/Docbook/Tcar-ug/Repository/History/2012.docbook +++ b/Documentation/Models/Docbook/Tcar-ug/Repository/History/2012.docbook @@ -19,7 +19,7 @@ The procedure used to locale messages inside the - centos-art.sh script had to be re-designed + centos-art.sh script has to be re-designed in order to accept such pluggable behavior into the script. We couldn't publish unique centos-art.sh.po and centos-art.sh.mo files because they diff --git a/Documentation/Models/Docbook/Tcar-ug/Repository/History/2013.docbook b/Documentation/Models/Docbook/Tcar-ug/Repository/History/2013.docbook index 9a00cfd..290647a 100644 --- a/Documentation/Models/Docbook/Tcar-ug/Repository/History/2013.docbook +++ b/Documentation/Models/Docbook/Tcar-ug/Repository/History/2013.docbook @@ -5,35 +5,20 @@ &TCAR; development was eventually stopped at November, 2012, when I moved myself from Cienfuegos to Havana city for working - on the insides restoration of Sagrado Corazón de Jesús - y San Ignacio de Loyola's church (also known - as Reina's church). The first months at Havana were very - difficult, specially at the moment of finding a stable place - to set my personal desktop (I was moved from one apartment to - another, frequently). It wasn't until January, 2013, when I - started to live in the church building itself when more stable - possibilities began to appear. + The first months were very difficult, specially at the moment + of finding a stable place to set my personal desktop (I was + moving myself from one apartment to another, frequently). - On April 9th, I begin a training on how to manage small - enterprises. This training take place in Reina's church, - specifically in a centre called La Anunciata. - This training demanded me attention, so the few hours I was - dedicating to &TCAR; at nights were reduced even more. - - - - On May 14th, the work at Reina's church ends for me and I have - to return to Cienfuegos city. It was not possible to conclude - the training on business management. I tried to take advantage - of the situation dedicating more work and study hours to - &TCAR; and the related automation scripts once again. At this - point I consider a Git+Gitolite+Gitweb infrastructure for + On May 14th, the work in Havana ends for me and I have to + return to Cienfuegos city. I tried to take advantage of the + situation dedicating more work and study hours to &TCAR; and + the related automation scripts once again. At this point I + consider a Git+Gitolite+Gitweb+MantisBT infrastructure for &TCAR; and start working on it in my workstation. This, in - order to implement a new work flow for &TCAR; based on Git - version control. + order to implement a distributed work flow for &TCAR; based on + Git version control system. @@ -64,7 +49,7 @@ - Add <filename>centos-art.conf</filename> file + Start Using The <filename>centos-art.conf</filename> File Based on the need of supporting more than one application to handle version control tasks, it was added the @@ -78,6 +63,64 @@ + + + Update Repository Directories Structure + + I face the following situation: I am working on a + documentation project named solinfo-network. + While I was organizing it, I found that the directory + structure of &TCAR; fits quite well the needs of + solinfo-network documentation project. However, + I don't want to duplicate automation scripts in two separate + projects, but share them between themselves (i.e., changes + committed to automation scripts are pushed to one single + place, not two.). + + + When we use Subversion repositories, it is possible to + checkout specific parts of different repositories into a new + repository. This is very useful if we need to create several + projects that share the same component and we don't want to + duplicate the common component in two or more different + projects but share it between them. See + . + + + + When we use Git repository, it is not possible to checkout + specific parts of a repository but the complete tree. So, in + order to share common components of a repository we need to + create one repository for each common component we want to + share and then use Git submodulessee progit-book, + page 152. This requires that brand new + repositories be created for each component we want to share. + + + + In both situations, including Git and Subversion repositories, + it is necessary that we define very well the structure of each + component we want to share, so it can be + plugged nicely into other projects. Likewise, + other projects must have the same directory structure the + pluggable component was design to fit in. If these two + conditions can be reached, it would be possible to reuse + repositories components and concentrate efforts. The current + directory structure &TCAR; is set in allows components inside + Subversion repositories to be reused by related working + copies. However, we cannot do the same if it is stored in a + Git repository. In order for Git repositories to be able to + share components with other Git repositories, &TCAR; directory + structure needs to be reorganized to better delineate each + component the repository is made of. + + + + For more information see . + + + +