1221
Comment:
|
← Revision 18 as of 2010-08-16 10:24:38 ⇥
6314
converted to 1.6 markup
|
Deletions are marked like this. | Additions are marked like this. |
Line 1: | Line 1: |
~+'''Reviews of Developer Manual devel'''+~ Please refer to [:Process/OtherReview_WithTitle:Other Review Process] for more information |
~+'''Reviews of Developer Manual devel'''+~ Please refer to [[Process/Document Review|Document Review Process]] for more information |
Line 4: | Line 4: |
||<bgcolor="#dddddd" style="text-align: center;"> '''Date:''' || <date when the review takes place on form YYYY/MM/DD> || ||<bgcolor="#dddddd" style="text-align: center;"> '''Version''' || <version i form of number or date> || ||<bgcolor="#dddddd" style="text-align: center;"> '''Lines/parts:''' || <lines/parts reviewed> || ||<bgcolor="#dddddd" style="text-align: center;"> '''Bugs/Feature requests:''' || <link to bug(s)/Feature request(s) partly or fully resolved by change> || ||<bgcolor="#dddddd" style="text-align: center;"> '''Time used:''' || <time used on document and review - used for [:Process/IterationReview:Iteration Review]> || [[BR]] ||<bgcolor="#dddddd" style="text-align: center;"> '''Line''' ||<bgcolor="#dddddd" style="text-align: center;"> '''Description''' ||<bgcolor="#dddddd" style="text-align: center;">'''Severity''' [[BR]] ~-Cosmetic, Minor, Major, Showstopper-~ ||<bgcolor="#dddddd" style="text-align: center;">'''Status''' [[BR]] ~-Ok, Postponed, Rejected, Obsolete-~ || || all/x-y || comment || - || - || |
||<bgcolor="#dddddd" style="text-align: center;"> '''Date:''' || 2009/03/18 || ||<bgcolor="#dddddd" style="text-align: center;"> '''Version''' ||latest version as of 2009/03/17 || ||<bgcolor="#dddddd" style="text-align: center;"> '''Lines/parts:''' ||Introduction, Overall Systems Description, Specific functions Description, Settings (section 5,1), Channels (section (5,2),, XML handling by Deploy (section 5.3), Running unit-tests (section 7,2,1) Development using Eclipse or Intellij || ||<bgcolor="#dddddd" style="text-align: center;"> '''Bugs/Feature requests:''' ||structure ([[https://gforge.statsbiblioteket.dk/tracker/index.php?func=detail&aid=1287&group_id=7&atid=108|FR 1287]]) batch ([[https://gforge.statsbiblioteket.dk/tracker/index.php?func=detail&aid=1216&group_id=7&atid=105|Bug 1216]]), upload, channels ([[https://gforge.statsbiblioteket.dk/tracker/index.php?func=detail&aid=1132&group_id=7&atid=105|Bug 1132]]) deduplication (task 44 in [[Iteration36TaskList|Iteration 36]]) || ||<bgcolor="#dddddd" style="text-align: center;"> '''Time used:''' || SVC: 1 MD, ELZI:? MD, CSR:1 MD || <<BR>> ||<bgcolor="#dddddd" style="text-align: center;"> '''Line''' ||<bgcolor="#dddddd" style="text-align: center;"> '''Description''' ||<bgcolor="#dddddd" style="text-align: center;">'''Severity''' <<BR>> ~-Cosmetic, Minor, Major, Showstopper-~ ||<bgcolor="#dddddd" style="text-align: center;">'''Status''' <<BR>> ~-Ok, Postponed, Rejected, Obsolete-~ || ||General ||fontsize in printer friendly version ||Cosmetic || P || ||General ||The use of security policies is not described in the manual ||Cosmetic || P || ||General ||Fix typos in the manual ||Cosmetic || P || ||Introduction ||Find another name for "plugging points" ||Cosmetic || P || ||Introduction ||After "or from Subversion repository", add: If you have joined the project at gforge ||Cosmetic || || ||General ||Section in Table of contents are not reproduced in the document ||Cosmetic || ? || ||Overall Systems Description ||"the first ...." => First we give an overview over the modules, and then go on to describe the database design ||Cosmetic || O || ||Database ||Missing fields in jobs table (submitteddate, resubmitted_as_jobId) on schematic||Cosmetic || Ok || ||Database ||Is it obvious for everyone what a cross-ref table is? ||Cosmetic || P || ||Database ||Difficult to see difference between normal tables and cross-ref tables in the schematic ||Cosmetic || P || ||Database ||Only possible to access createfullhddb.sql if you have an account on gforge ||Cosmetic || R || ||Batch on Bitarchives ||Sections "execution and parameters", and "Example of packing and executing a batchjob" does not really belong to the developer manual. Maybe move to user manual. ||Cosmetic || O || ||ViewerProxy ||In printer friendly version, uninterpreted html tags areas shown as clear text (e.g. "tt" tag) ||Cosmetic || P || ||ViewerProxy ||The section headings "Viewerproxy Control resolver", and "Observer resolver" contradicts the contents of these sections ||Cosmetic || O || ||Upload of files || Does not belong to developer manual. Belongs to the User manual ||Cosmetic || O || ||Harvesting Roundtrip ||Reference to table "domainconfigurations" is wrong. The table is named "configurations" ||Cosmetic || || ||Harvesting Roundtrip ||"creating new jobs for harvest ...." does not make sense. We are creating jobs on the basis of harvestdefinitions. A set of jobs created on the basis of a harvestdefinition constitutes a harvest ||Cosmetic || || ||Running Heritrix ||Reference to a subtle bug in Heritrix. Which bug is that??? ||Cosmetic || || ||Harvesting Roundtrip ||scheduler executes every minute. Refer to this constant ||Cosmetic || || ||Running Heritrix ||l"..log status reports every 20 seconds". Is this a hardwired constant somewhere, or is is wrong? ||Cosmetic || || ||Creating metadata ||Note that the metadata-1.arc files are the only arcfiles produced, that have no timestamp included in their name ||Cosmetic || || ||Old jobs ||This process is also done after a crawlJob has finished either successfully or otherwise ||Cosmetic || || ||Deduplicates ||Describe what deduplication is all aboyt ||Cosmetic || P || ||Deduplicates ||Add reference(link) to section "Indexing and caching" after subsection starting with "Generation of deduplication indices" ||Cosmetic || P || ||Sending Patches ||Consider moving this section to the bottom or further up ||Cosmetic || || ||Sending Patches ||The link to the twiki page http://netarchive.dk/suite/Process/Create_Tracker_Issue_WithTitle ||Cosmetic || || ||Settings ||Mention that you need to define what local settings-file you are using, if you need to override the default settings. Ddk.netarkivet.settings.file=tests/dk/netarkivet/test-settings.xml || ||P || ||Settings ||As of version 3.8+ || R || || ||Settings ||"(also deploy in checks.." (Does not understand?) || || || ||Settings ||"if needed" => If the quickstart requires another value than the default for this setting || || || ||Settings ||"The Deploy manual" => "The Installation manual" || || || ||Channels ||Add general description about the Channels, and its relation to JMS messages || ||P || ||Channels ||Move contents of section "Placement .." to general description of channels. || || || ||Channels ||The type ..." => The type of channel is indicated by the Channel Prefix... || || || ||Channels||in subsection EnvironmentName, change to: Initials of developer identication a environment for a test run by this person|| || || ||Channels ||Move description of the table after the table itself || || || ||Localization ||A German translation now exists also || || || ||Localization ||"but for details consult the XXX": ???? || ||P || ||JSP ||Include a sample jsp page || ||P || ||XML handling by Deploy ||Replace section with a description of processes around deploy || ||P || ||Exceptions ||"undeclared exceptions": Undeclared implies unchecked. || || || ||Practical Matters, running unittest||-Xmx152m => -Xmx512m Add Security policy manager, and link til security policy file.|| || || |
Reviews of Developer Manual devel Please refer to Document Review Process for more information
New reviews are added at the top
Date: |
2009/03/18 |
Version |
latest version as of 2009/03/17 |
Lines/parts: |
Introduction, Overall Systems Description, Specific functions Description, Settings (section 5,1), Channels (section (5,2),, XML handling by Deploy (section 5.3), Running unit-tests (section 7,2,1) Development using Eclipse or Intellij |
Bugs/Feature requests: |
structure (FR 1287) batch (Bug 1216), upload, channels (Bug 1132) deduplication (task 44 in Iteration 36) |
Time used: |
SVC: 1 MD, ELZI:? MD, CSR:1 MD |
Line |
Description |
Severity |
Status |
General |
fontsize in printer friendly version |
Cosmetic |
P |
General |
The use of security policies is not described in the manual |
Cosmetic |
P |
General |
Fix typos in the manual |
Cosmetic |
P |
Introduction |
Find another name for "plugging points" |
Cosmetic |
P |
Introduction |
After "or from Subversion repository", add: If you have joined the project at gforge |
Cosmetic |
|
General |
Section in Table of contents are not reproduced in the document |
Cosmetic |
? |
Overall Systems Description |
"the first ...." => First we give an overview over the modules, and then go on to describe the database design |
Cosmetic |
O |
Database |
Missing fields in jobs table (submitteddate, resubmitted_as_jobId) on schematic |
Cosmetic |
Ok |
Database |
Is it obvious for everyone what a cross-ref table is? |
Cosmetic |
P |
Database |
Difficult to see difference between normal tables and cross-ref tables in the schematic |
Cosmetic |
P |
Database |
Only possible to access createfullhddb.sql if you have an account on gforge |
Cosmetic |
R |
Batch on Bitarchives |
Sections "execution and parameters", and "Example of packing and executing a batchjob" does not really belong to the developer manual. Maybe move to user manual. |
Cosmetic |
O |
In printer friendly version, uninterpreted html tags areas shown as clear text (e.g. "tt" tag) |
Cosmetic |
P |
|
The section headings "Viewerproxy Control resolver", and "Observer resolver" contradicts the contents of these sections |
Cosmetic |
O |
|
Upload of files |
Does not belong to developer manual. Belongs to the User manual |
Cosmetic |
O |
Harvesting Roundtrip |
Reference to table "domainconfigurations" is wrong. The table is named "configurations" |
Cosmetic |
|
Harvesting Roundtrip |
"creating new jobs for harvest ...." does not make sense. We are creating jobs on the basis of harvestdefinitions. A set of jobs created on the basis of a harvestdefinition constitutes a harvest |
Cosmetic |
|
Running Heritrix |
Reference to a subtle bug in Heritrix. Which bug is that??? |
Cosmetic |
|
Harvesting Roundtrip |
scheduler executes every minute. Refer to this constant |
Cosmetic |
|
Running Heritrix |
l"..log status reports every 20 seconds". Is this a hardwired constant somewhere, or is is wrong? |
Cosmetic |
|
Creating metadata |
Note that the metadata-1.arc files are the only arcfiles produced, that have no timestamp included in their name |
Cosmetic |
|
Old jobs |
This process is also done after a crawlJob has finished either successfully or otherwise |
Cosmetic |
|
Deduplicates |
Describe what deduplication is all aboyt |
Cosmetic |
P |
Deduplicates |
Add reference(link) to section "Indexing and caching" after subsection starting with "Generation of deduplication indices" |
Cosmetic |
P |
Sending Patches |
Consider moving this section to the bottom or further up |
Cosmetic |
|
Sending Patches |
The link to the twiki page http://netarchive.dk/suite/Process/Create_Tracker_Issue_WithTitle |
Cosmetic |
|
Settings |
Mention that you need to define what local settings-file you are using, if you need to override the default settings. Ddk.netarkivet.settings.file=tests/dk/netarkivet/test-settings.xml |
|
P |
Settings |
As of version 3.8+ |
R |
|
Settings |
"(also deploy in checks.." (Does not understand?) |
|
|
Settings |
"if needed" => If the quickstart requires another value than the default for this setting |
|
|
Settings |
"The Deploy manual" => "The Installation manual" |
|
|
Channels |
Add general description about the Channels, and its relation to JMS messages |
|
P |
Channels |
Move contents of section "Placement .." to general description of channels. |
|
|
Channels |
The type ..." => The type of channel is indicated by the Channel Prefix... |
|
|
Channels |
in subsection EnvironmentName, change to: Initials of developer identication a environment for a test run by this person |
|
|
Channels |
Move description of the table after the table itself |
|
|
Localization |
A German translation now exists also |
|
|
Localization |
"but for details consult the XXX": ???? |
|
P |
JSP |
Include a sample jsp page |
|
P |
XML handling by Deploy |
Replace section with a description of processes around deploy |
|
P |
Exceptions |
"undeclared exceptions": Undeclared implies unchecked. |
|
|
Practical Matters, running unittest |
-Xmx152m => -Xmx512m Add Security policy manager, and link til security policy file. |
|
|