From: Gianluca S. <gi...@gm...> - 2008-01-30 23:08:14
|
Hi everybody, In the last few weeks I worked on converting the mantis manual from HTML to DocBook format. This is the first step of a process with the following goals: 1. have a single, versioned source for HTML and PDF manuals 2. keep the manual more up to date with new features 3. allow translators to provide localized documentation The requirements we identified so far are: * we want to tag/branch manual+sources at the same time * we want a single location for all the translations * we do not want to force downloading manual for just working on the code, and vice versa To support all of the above, I think we need a major reorganization of the repository; something like: ROOT=http://mantisbt.svn.sourceforge.net/viewvc/mantisbt/trunk $ROOT/sources $ROOT/sources/mantis << actual source code $ROOT/sources/manual $ROOT/sources/manual/$LANG << one of these for each language Questions, comments or alternative ideas on the topic are very welcome Cheers Gianluca |
From: John R. <jr...@le...> - 2008-01-31 02:31:18
|
Gianluca Sforna wrote: > To support all of the above, I think we need a major reorganization of > the repository; something like: > > ROOT=http://mantisbt.svn.sourceforge.net/viewvc/mantisbt/trunk > > $ROOT/sources > $ROOT/sources/mantis << actual source code > $ROOT/sources/manual > $ROOT/sources/manual/$LANG << one of these for each language > > Questions, comments or alternative ideas on the topic are very welcome What's wrong with the existing repository layout? The manual is already separated from the mantis source code; why not just clear out and subdivide that directory instead of rearranging everything? -- John Reese LeetCode.net |
From: Gianluca S. <gi...@gm...> - 2008-01-31 08:47:06
|
On Jan 31, 2008 3:31 AM, John Reese <jr...@le...> wrote: > Gianluca Sforna wrote: > > To support all of the above, I think we need a major reorganization of > > the repository; something like: > > > > ROOT=http://mantisbt.svn.sourceforge.net/viewvc/mantisbt/trunk > > > > $ROOT/sources > > $ROOT/sources/mantis << actual source code > > $ROOT/sources/manual > > $ROOT/sources/manual/$LANG << one of these for each language > > > > Questions, comments or alternative ideas on the topic are very welcome > > What's wrong with the existing repository layout? The manual is already > separated from the mantis source code; why not just clear out and > subdivide that directory instead of rearranging everything? > You snipped the reason why I think it does not work... I'll repeat it here: 1. we want to tag/branch manual+sources at the same time 2. we do not want to force downloading manual for just working on the code, and vice versa For 1, we need /manual to be either a sibling or a child of /mantisbt; on the other side, 2 exclude /manual to be a child, so we are left with just the sibling option. Of course, if we decide 1 or 2 are not really "strong" requirements, the existing layout looks just fine. |
From: Victor B. <vb...@gm...> - 2008-01-31 09:01:34
|
Hi Gianluca, On Jan 31, 2008 12:46 AM, Gianluca Sforna <gi...@gm...> wrote: > On Jan 31, 2008 3:31 AM, John Reese <jr...@le...> wrote: > > Gianluca Sforna wrote: > > > To support all of the above, I think we need a major reorganization of > > > the repository; something like: > > > > > > ROOT=http://mantisbt.svn.sourceforge.net/viewvc/mantisbt/trunk > > > > > > $ROOT/sources > > > $ROOT/sources/mantis << actual source code > > > $ROOT/sources/manual > > > $ROOT/sources/manual/$LANG << one of these for each language > > > > > > Questions, comments or alternative ideas on the topic are very welcome > > > > What's wrong with the existing repository layout? The manual is already > > separated from the mantis source code; why not just clear out and > > subdivide that directory instead of rearranging everything? > > > > You snipped the reason why I think it does not work... I'll repeat it here: > > 1. we want to tag/branch manual+sources at the same time [Victor] This is essential as we discussed. > 2. we do not want to force downloading manual for just working on the > code, and vice versa [Victor] I think if we go with a sibling option, a lot of developers won't get it and hence won't update it. what we are aiming for is a process where a dev (or a contributor) will implement a feature, update the manual, and checkin / provide a patch. > For 1, we need /manual to be either a sibling or a child of /mantisbt; > on the other side, 2 exclude /manual to be a child, so we are left > with just the sibling option. [Victor] I was thinking about one of the following options: $ROOT=http://mantisbt.svn.sourceforge.net/viewvc/mantisbt/trunk/ $ROOT/mantisbt/docbook/<book name>/$LANG OR $ROOT/mantisbt/doc/<book name>/$LANG <bookname> - userguide, administrationguide, developersguide, etc. The release script will have to be updated to do the necessary compilations, put the docbook sources as a separate archive and place the compiled docbook into the doc/ folder (e.g. single file html format). The release archive should not include the docbook source files. > Of course, if we decide 1 or 2 are not really "strong" requirements, > the existing layout looks just fine. > > > ------------------------------------------------------------------------- > This SF.net email is sponsored by: Microsoft > Defy all challenges. Microsoft(R) Visual Studio 2008. > http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/ > _______________________________________________ > mantisbt-dev mailing list > man...@li... > https://lists.sourceforge.net/lists/listinfo/mantisbt-dev > |
From: Gianluca S. <gi...@gm...> - 2008-01-31 10:05:23
|
On Jan 31, 2008 10:01 AM, Victor Boctor <vb...@gm...> wrote: > > 2. we do not want to force downloading manual for just working on the > > code, and vice versa > [Victor] I think if we go with a sibling option, a lot of developers > won't get it and hence won't update it. what we are aiming for is a > process where a dev (or a contributor) will implement a feature, > update the manual, and checkin / provide a patch. Well, manual could grow very large, especially with translations. I thought that developers would not be interested in downloading the whole set of translations ( at least, I am not :) ) and, honestly, I can't see having the manual under /mantisbt as a big incentive to keep it up to date with code. I think that is more a matter of developers "good will"... > > > For 1, we need /manual to be either a sibling or a child of /mantisbt; > > on the other side, 2 exclude /manual to be a child, so we are left > > with just the sibling option. > [Victor] I was thinking about one of the following options: > > $ROOT=http://mantisbt.svn.sourceforge.net/viewvc/mantisbt/trunk/ > $ROOT/mantisbt/docbook/<book name>/$LANG > > OR > > $ROOT/mantisbt/doc/<book name>/$LANG > > <bookname> - userguide, administrationguide, developersguide, etc. does SVN allows us to give translators commit access to a directory, but not its parent? otherwise we need to trust them not touching the mantis code... > > The release script will have to be updated to do the necessary > compilations, put the docbook sources as a separate archive and place > the compiled docbook into the doc/ folder (e.g. single file html > format). The release archive should not include the docbook source > files. > Agreed |
From: John R. <jr...@le...> - 2008-01-31 14:55:49
|
Gianluca Sforna wrote: > 1. we want to tag/branch manual+sources at the same time > 2. we do not want to force downloading manual for just working on the > code, and vice versa > > For 1, we need /manual to be either a sibling or a child of /mantisbt; > on the other side, 2 exclude /manual to be a child, so we are left > with just the sibling option. But mantisbt/ and manual/ are already siblings. Whenever we tag/branch Mantis, we already tag/branch the entire trunk repository. Why would this need to change? I'm not understanding why we can't already tag the manual and the source tree at the same time. -- John Reese LeetCode.net |
From: Gianluca S. <gi...@gm...> - 2008-01-31 15:17:50
|
On Jan 31, 2008 3:55 PM, John Reese <jr...@le...> wrote: > Gianluca Sforna wrote: > > 1. we want to tag/branch manual+sources at the same time > > 2. we do not want to force downloading manual for just working on the > > code, and vice versa > > > > For 1, we need /manual to be either a sibling or a child of /mantisbt; > > on the other side, 2 exclude /manual to be a child, so we are left > > with just the sibling option. > > But mantisbt/ and manual/ are already siblings. Whenever we tag/branch > Mantis, we already tag/branch the entire trunk repository. Why would > this need to change? I'm not understanding why we can't already tag the > manual and the source tree at the same time. Actually, we branch only /mantisbt (or at least that's the only directory in BRANCH_1_1_0) and I wrongly assumed we would be forced to branch/tag also /dev and other stuff we could have in trunk/ So you are right. what I proposed can be done without moving /mantisbt around... sorry for the noise If Victor has no objections, I'll start adding the manual to /trunk to see how it works; it can be moved into mantisbt later if we realize it lacks the required "visibility". |
From: Gianluca S. <gi...@gm...> - 2008-02-02 22:50:49
|
On Jan 31, 2008 4:17 PM, Gianluca Sforna <gi...@gm...> wrote: > > If Victor has no objections, I'll start adding the manual to /trunk to > see how it works; it can be moved into mantisbt later if we realize it > lacks the required "visibility". > FYI, we agreed with Victor to put the current manual in: mantisbt/docbook/adminguide/en this supports more books to exist in docbook/ and more than one translation for each book I'm going to commit the current version ASAP |