View Issue Details
ID | Project | Category | View Status | Date Submitted | Last Update |
---|---|---|---|---|---|
0017781 | mantisbt | documentation | public | 2014-10-16 12:38 | 2014-11-20 16:54 |
Reporter | Horinius | Assigned To | dregad | ||
Priority | low | Severity | tweak | Reproducibility | N/A |
Status | closed | Resolution | fixed | ||
Product Version | 1.3.0dev | ||||
Summary | 0017781: Suggestion: breaking Configuration.xml file into smaller pieces | ||||
Description | I was working on bug 16610 (http://www.mantisbt.org/bugs/view.php?id=16610) where I found that Configuration.xml file of the Admin Guide was very big. My suggestion is to break it down into smaller pieces: every file for each section (Database, Path, Webserver, etc). Actually, in general case, it's always better to have smaller files since that could reduce the chance that two people are working on the same files and generating conflict (even though Git helps use sort out this kind of situation). I think this suggestion is feasible since the Admin Guide source files are already divided into chapters. Few days ago, I wanted to try compiling the guide with Publican by following the README to see how to proceed the breaking, so it failed. So I didn't go very far. Are the instructions inside README still correct? | ||||
Tags | No tags attached. | ||||
Hello Thanks for your suggestion. In response to your arguments
I agree that working with a 4000-line file can be unwieldy. On the other hand, having to handle many small files (keep in mind we are talking about 37 distinct sections here, some of them with just 1-2 configs) can potentially be just as difficult to manage (e.g. finding the right file(s) to edit, replicating changes across multiple files).
Definitely not an issue in our case as 1. we have a small team; 2. documentation is not updated so frequently. Consequently it's very unlikely we'd see any conflicting updates and even if we did, as you pointed out, GIT would make resolving them easy. Based on the above, I am not sure we would gain anything from such a split, and would recommend against it.
As far as I can tell, yes they are although it assumes that you have a properly setup and operational publican / docbook stack on your computer. Without further info, it's a bit difficult to give you any further details. |
|
Then at least cut it into files of about 300 lines. When I was using Github's online editor, it was a pain in the part-of-the-body-you-name-it. Anyway, do as you like. If the file size is smaller, I'll continue on the other bug. Otherwise, I will leave it to others. |
|
Found a script to handle the splitting - is this what you had in mind ? https://github.com/dregad/mantisbt/tree/docbook-split/docbook/Admin_Guide/en-US |
|
I saw the "config" sub folder and those xml files. Yes, that's what I mean. Does it compile well? |
|
Yes it compiles OK. Removed target version since this kind of changes should not appear on Changelog. |
|
MantisBT: master cf27b294 2014-10-22 14:52 Details Diff |
Admin Guide: split Configuration chapter by section The Configuration.xml docbook file was nearly 4000 lines, making it unwieldy to edit. Each section was moved to a separate file in new subdirectory 'config', and included in the main file with xi:includes. The operation was handled using 'dbautosplit' perl script from http://rpmfind.net/linux/rpm2html/search.php?query=dbautosplit with some manual adjustments to the generated files. Fixes 0017781 |
Affected Issues 0017781 |
|
mod - .gitignore | Diff File | ||
mod - docbook/Admin_Guide/en-US/Configuration.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/auth.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/bughistory.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/bugnote.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/cookies.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/customfields.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/database.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/date.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/defaults.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/display.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/email.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/fields.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/filters.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/html.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/language.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/logging.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/misc.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/myview.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/news.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/path.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/relationship.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/reminders.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/security.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/settings.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/signup.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/soap.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/speed.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/sponsorship.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/status.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/subprojects.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/summary.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/tables.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/time.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/timetracking.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/timezone.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/uploads.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/version.xml | Diff File | ||
add - docbook/Admin_Guide/en-US/config/webserver.xml | Diff File |