3604
Comment:
|
← Revision 106 as of 2012-03-28 07:15:39 ⇥
934
|
Deletions are marked like this. | Additions are marked like this. |
Line 1: | Line 1: |
[[title(Development - Various Information)]] [[Action(edit)]] |
---- = Note that the information found here is in the process of being migrated to the new SBForge wiki at https://sbforge.org/display/NAS/NetarchiveSuite = ---- <<title(Development - Various Information)>> <<Action(edit)>> |
Line 4: | Line 6: |
~+'''''Shortcuts:'''''+~ [[BR]] Shortcuts are for developers and will reflect the contents of this page, but it will also include links to items on other wikis that are not yet public. |
~+'''''Table Of Contents:'''''+~ <<TableOfContents(2)>> |
Line 7: | Line 8: |
'''Project''': [:Development#Assignments:Assignment Descriptions] | [:Development#Iterations:Iterations] | [:Iteration36:Iteration 36] | [:Iteration36TaskList:Task List 36] | [:Iteration36ReviewsOverview:Reviews 36] | [http://kb-prod-udv-001.kb.dk/twiki/bin/view/Netarkiv/Iteration36ReleaseTest Release Test 36] [[BR]] '''Processes''': [:Development#Methodology:Methodology] | [:Process:All processes] | [:ProcessList:Process List] | [:Process/Overall_Steering_Processes:Overall Steering] | [:Process/Iteration_Lifecycle:Iteration Lifecycle] | [:Process/Tracker_Issue_Lifecycle:Tracker Issue Lifecycle] | [:Process/Continuous_Code_QA:Continuous Code QA] [[BR]] '''Roles''': [http://kb-prod-udv-001.kb.dk/twiki/bin/view/Netarkiv/RolleBemanding Staffing] | [:Process_Role:All roles] | [:Process_Role/Project_Leader:Project Leader] | [:Process_Role/Module_Owner:Module Owner] | [:Process_Role/External_SW_Coordinator:External Software] | [:Process_Role/Configuration_Coordinator:Configuration] | [:Process_Role/QA_Coordinator:QA] | [:Process_Role/Documentation_Coordinator:Documentation] | [:Process_Role/Test_Coordinator:Test] | [:Process_Role/Task_Holder:Task holder] [[BR]] '''Code''': [https://gforge.statsbiblioteket.dk/plugins/scmsvn/viewcvs.php/trunk/?root=netarchivesuite SVN] | [http://netarchive.dk/apidocs/ Javadoc] | [:Process/Code_Review:Code Reviews] | [http://kb-prod-udv-001.kb.dk:8060/ Crucible review tool] [[BR]] '''Code internal''': [https://kb-prod-udv-001.kb.dk/internetbevaring/docs/ Reports] | [https://kb-prod-udv-001.kb.dk/cvsweb/cvsweb.cgi/ old CVS] | [https://kb-prod-udv-001.kb.dk/internetbevaring/docs/xref/ Source Xref]/[http://kb-prod-udv-001.kb.dk/maven-current-iteration-output.txt log] | [https://kb-prod-udv-001.kb.dk/internetbevaring/docs/pmd-report.html PMD-rapport] | [https://kb-prod-udv-001.kb.dk/internetbevaring/docs/findbugs-report.html Findbugs-report] ([http://findbugs.sourceforge.net/bugDescriptions.html findbugs-help]) | [https://kb-prod-udv-001.kb.dk/internetbevaring/docs/checkstyle/index.html Checkstyle(maven)-report] | [http://kb-prod-udv-001.kb.dk/clover/clover_current/ Clover report]/[https://kb-prod-udv-001.kb.dk/clover/clover-log.txt log]/[https://kb-prod-udv-001.kb.dk/clover/clover-manual.pdf manual] | [https://kb-prod-udv-001.kb.dk/qa/runningAs.txt Unittest exclusions] | [http://kb-prod-udv-001.kb.dk/twiki/bin/view/Netarkiv/SubVersion SubVersion] [[BR]] '''Bugs''': [:BugInfGuide: Inf. guide] | [https://gforge.statsbiblioteket.dk/tracker/?atid=105&group_id=7&func=browse Bugs] | [https://gforge.statsbiblioteket.dk/tracker/?atid=107&group_id=7&func=browse Patches] | [https://gforge.statsbiblioteket.dk/tracker/?atid=108&group_id=7&func=browse Feature requests] | [http://kb-prod-udv-001.kb.dk/bugzilla/ Old bug list] | [http://kb-prod-udv-001.kb.dk/twiki/bin/view/Netarkiv/StatisticsBugComponentNew Bugs Statistics] [[BR]] |
<<Anchor(DevIntroduction)>> <<Include(Development/Introduction)>> |
Line 14: | Line 10: |
'''''Note: Shortcut list is not complete''''' | <<Anchor(DevCommunication)>> <<Include(Development/Communication)>> |
Line 16: | Line 12: |
~+'''''Table Of Contents:'''''+~ | <<Anchor(DevShortCuts)>> <<Include(Development/ShortCuts)>> |
Line 18: | Line 14: |
[[TableOfContents]] | <<Anchor(DevRepository)>> <<Include(Development/Repository)>> |
Line 20: | Line 16: |
[[Include(Development/Introduction)]] | <<Anchor(DevProjectPipeline)>> <<Include(Development/ProjectPipeline)>> |
Line 22: | Line 18: |
[[Include(Development/Communication)]] | <<Anchor(DevProjectCurrent)>> <<Include(Development/ProjectCurrent)>> |
Line 24: | Line 20: |
[[Include(Development/Repository)]] | <<Anchor(DevMethodology)>> <<Include(Development/Methodology)>> |
Line 26: | Line 22: |
[[Include(Development/ProjectPipeline)]] | <<Anchor(DevGuidelinesAndPolicies)>> <<Include(Development/GuidelinesAndPolicies)>> |
Line 28: | Line 24: |
[[Include(Development/ProjectCurrent)]] [[Include(Development/Methodology)]] [[Include(Development/GuidelinesAndPolicies)]] [[Include(Development/GeneratedReports)]] |
<<Anchor(DevGeneratedReports)>> <<Include(Development/GeneratedReports)>> |
Note that the information found here is in the process of being migrated to the new SBForge wiki at https://sbforge.org/display/NAS/NetarchiveSuite
Development - Various Information
editTable Of Contents:
Contents
- Note that the information found here is in the process of being migrated to the new SBForge wiki at https://sbforge.org/display/NAS/NetarchiveSuite
- Introduction
- How to contribute with patches to NetarchiveSuite
- Developer Short Cuts
- Repository
- Projects in pipeline
- Current Project Information
- Development Methodology
- Guidelines & Policies
- Generated reports
Introduction
The NetarchiveSuite system is continuously under development. The information given on this page is primarily information used in development work, including coordination between different institutions with developers.
The Communication section gives information of to communicate as a developer or contributer.
The Developer Short Cuts section lists usefull short cuts when doing development work, however it may be a good idea to get acquainted with repository, methodology and guidelines & policies before using these short cuts.
The Repository section explains where code and code related information is placed.
The Projects in pipeline section gives reference to various design discussion and assignments for tasks that may or may not become implemented at a later stage. This is mainly concerned with bigger changes.
The Current Project Information contains the current and past information about iterations, produced as part of following the development methodology as well as the current staffing of the roles used in the development methodology.
The Development Methodology section describes the processes and related roles which is basis for how the development work is done.
The Guidelines & Policies section includes references to guidelines that supports various processes and administration routines.
The Generated reports section includes references to automatically generated reports, mainly concerned with code and bugsthat supports.
How to contribute with patches to NetarchiveSuite
Description of how to contribute is given by the process description (especially the Tracker Issue Life-Cycle process which includes an Implementation process) and various coding guidelines (including unit test). If you read it and follow the suggestions therein, you will not only make it easier to get your changes to NetarchiveSuite be accepted into the main distribution, you will also likely improve the quality of your code overall.
We're always happy to receive patches, though we may choose not to apply them if the implemented features go against our purposes or the code quality is too low.
If possible, use our patch-tracker to transmit the patch to us. The Create Tracker Issue process describes how.
If sending patches by email, please follow the Create Tracker Issue process as far as possible, and please send files as attachments rather than inline, as mail readers tend to mess up important formatting.
For further information please to the Communication tab.
Developer Short Cuts
Shortcuts are for developers and will reflect the contents of this page, but it will also include links to items on other wikis that are not yet public. To link to this place use the link http://netarchive.dk/suite/Development#DeveloperShortCuts.
Project: Assignment Descriptions | Iterations | Iteration 44 | Task List 44 | Reviews 44 | Releasetest 42 (testing for current stable release)| Releasetest 43| Releasetest 44| Bug1986Releasetest | Patch3.12.2Releasetest| Releasetest 45| Releasetest 46| Iteration Timesheet
Processes: Methodology | All processes | Process List | Overall Steering | Iteration Lifecycle | Tracker Issue Lifecycle
Roles: Staffing | All roles | Roles List | Proj. Leader | Module Owner | External SW | Adm. | QA | Documentation | Test | Task holder
Guidelines: Guidelines | Sun's guidelines | JavaDoc guidelines | Version Numbers | Java modifiers | Java Exceptions
Old Guidelines: Old UnitTests | Old Java Logging | Old Java Exceptions | Old KonfigurationsData | Old JSP | Old Db Impl Guidelines | Old JobGeneration
Code: SVN | Javadoc | Code Reviews | Crucible review tool
Code internal: Reports | kb-prod-udv-001.kb.dk CVS repository (password protected) | Source Xref/log | PMD-rapport | Findbugs-report (findbugs-help) | Checkstyle(maven)-report | Clover report/log/manual | Unittest exclusions | Notes about the move to SubVersion (in Danish)
Bugs: Inf. guide | Bugs | Patches | Feature requests
Manuals in progress: Quick Start Manual, Additional Tools Manual, System Design, Configuration Manual, Installation Manual, User Manual
Various Internal: Internal Calender
Repository
To follow the latest developments, go to the SVN repository, which contains latest updates of code and see the current list of bugs, patches and feature requests.
The guide for how to register a bug, a patch or a feature request can be found at Bug/Feature Request/Patch Information Guideline
But check first, that the bug or feature request has not been reported already: list of existing bugs, patches and feature requests
To see the latest releases go to registration and download
Projects in pipeline
Assignments
Assignments have not yet been generally moved to from our internal wiki to this wiki, but new assignments will show up here until we get the rest moved. The assignments are divided by module.
For further description of the modules, please refer to Module description in System Design document.
For further descripttion of naming conventions of assignments, please refer to the Assignment Description Guidelines in section Guidelines & Policies.
Assignments for module Access
Access Assignment 1 Develop working prototype for Wayback access
(older version: WaybackAssignments20081119.odt )Access Assignment 2 Integrate Wayback development into main project
Access Assignment 3 Tools for Automatic Maintenance of Wayback Installation
Access Assignment 4 NutchWAX integration into NetarchiveSuite.
Assignments for module Archive
Assignment Group B.2 Improve and isolate bit preservation GUI.( >50% DONE)
Assignment Group B.4 Improve batch job architecture (>30% DONE)
Assignments for module Common
There are currently no new assignments for the Common module.
Assignments for module Deploy
Deploy Assignment 1 Rewrite deploy based on settings overwrite (DONE)
Assignments for module Harvester
Harvester Assignment 1 Upgrade to Heritrix release 3
Harvester Assignment 2 Move to WARC writing instead of ARC writing
Harvester Assignment 3 A tool for monitoring broad crawls (DONE)
Harvester Assignment 4 Global Crawler Traps (An upgraded version of this has been released in 3.12, that stores the crawlertraps in the harvester database)
Discussion Harvester 1 Migration of Harvest Definition database to Hibernate
Assignments for module Monitor
There are currently no new assignments for the Monitor module.
Prioritize assignments from Viena workshop
Priority made by the Netarkiv.dk development group (SB/KB)
4. WARC support
The following wishes might be too complex (rewrite of a large part of NAS's core functionality)
The following wish should be in cooperation with project “National Bitmagasin” as it is a complex task. Might not be a NAS task
The following wish is from BNF (not a priority from UDV SB/KB. Therefore not estimated ):
Old Assignments
These are only represented on the old wiki:
Requirement list
These only exist on the old Wiki as requirement list. There are in the process of being put into Feature Requests.
Current Project Information
Staffing
Staffing of Roles
Role (Updated 25. August 2010) |
Responsible |
Backup |
MSS |
JOLF |
|
MSS |
TLR |
|
MSS |
SVC |
|
MSS |
SVC |
|
SVC |
CSR |
|
MSS |
JOLF |
Staffing of Module Ownership
Main Module (Updated 11. January 2011) |
Module Owner |
Backup |
Viewerproxy |
CSR |
|
Archive* |
JOLF |
|
Common |
CSR |
|
Harvester GUI part |
SVC |
CSR |
Harvester harvest part |
SVC |
CSR |
Deploy |
JOLF |
|
Other Module |
Module Owner |
Backup |
Documentation |
MSS |
|
Monitor |
CSR |
|
Test |
MSS |
* Archive includes: arcrepository, batch, bitarchive (and checksum archive), bitpreservation, logicalpreservation, Indexserver.
Current Iteration
Please refer to Iteration 47
Current Iteration Task Overview
Please refer to Iteration 47 Task List
Current Reviews
Please refer to Iteration 47 Reviews
Current Release Test
Open area for Releasetest 47 (not open yet)
Closed area for Iteration 47 Release Test
Old Iterations (incl. Test, reviews)
Iteration 46: Ended February 28 2011 with the development release 3.15.0 of NetarchiveSuite
Iteration 45: Ended November 5 2010 with the stable release 3.14.0 of NetarchiveSuite
Iteration 44: Ended September 9 2010 with the development release 3.13.1 of NetarchiveSuite
Iteration 43: Ended June 15 2010 with the development release 3.13.0 of NetarchiveSuite
Iteration 42: Ended May 4 2010 with the release of NetarchiveSuite 3.12.0
Iteration 41: Ended February 18 2010 with the release of NetarchiveSuite 3.11.2
Iteration 40: Ended December 18 2009 with the release of NetarchiveSuite 3.11.0
Iteration 39: Ended November 16 2009 with the release of NetarchiveSuite 3.10.0
Iteration 38: Ended October 06 2009 with the release of NetarchiveSuite 3.9.2
Iteration 37: Ended August 10 2009 with the release of NetarchiveSuite 3.9.0
Iteration 36: Ended May 25 2009 with the release of NetarchiveSuite 3.8.0
For Iterations before 36, please refer to old iterations on old wiki (not open).
Development Methodology
The development methodology described here is inspired by CMMI (http://www.sei.cmu.edu/cmmi/). It will be described in form of processes and roles.
The processes are either main processes or subprocesses covered by a main process. Each main process includes an overview and the processes and roles involved. Each subprocess includes a description, a purpose, the role responsible for the subprocess, the method used in form of activities, the time it takes place and its input and output.
Each role includes a description, the processes the role is responsible for, and the guidelines relevant for the role, any references to current work and backup staffing list.
To insert a new process or role description, please refer to the Guidelines for Writing a new Process or Role.
Processes
To get the page with all process descriptions in structured form, please refer to All Processes.
Roles
To get the page with descriptions of all our roles, please refer to All Roles page.
Guidelines & Policies
<There are still more sections than the below indicated sections which needs to be moved from the old to the new wiki>
New Process
Please refer to the Guidelines for writing a new process or role
Code related
Maintain Documentation
The documentation for the NetarchiveSuite software is maintained for both the current stable branch, and the development branch. The document Maintaining Documentation describes the steps necessary for transferring the development branch documentation to the stable branch, when making a stable release.
To produce PDFs, please refer to the Generate PDF from manual guideline.
Assignment Description Guidelines
Please refer to Assignment Writing
Release Policy
There are several things to do when we make a release. Please see the page on Release Procedures for further information.
Tracker (Bug/Feature-Request/Patch) registration
Please refer to the bug information guideline
Placement of log-files
Please refer to the Hints to Where to Find Log-files
Crucible Guidelines for sign-up
Crucible Guidelines for sign-up
Crucible Administration Guidelines
Generated reports
JavaDocs all versions
Javadoc for latest stable release: http://netarchive.dk/apidocs/3.14.0
Source Xref/log
Source Xref: http://kb-prod-udv-001.kb.dk/netarchivesuite/maven/docs/xref/index.html
Log: http://kb-prod-udv-001.kb.dk/netarchivesuite/maven/maven-current-iteration-output.txt
Findbugs-report
Findbugs-report: http://kb-prod-udv-001.kb.dk/netarchivesuite/maven/docs/findbugs-report.html
Findbugs help: http://findbugs.sourceforge.net/bugDescriptions.html
Clover-report
Clover-report: http://kb-prod-udv-001.kb.dk/netarchivesuite/clover/clover_current/
Clover-report-log: http://kb-prod-udv-001.kb.dk/netarchivesuite/clover/clover-log.txt
Checkstyle-report (maven)
Checkstyle-report: http://kb-prod-udv-001.kb.dk/netarchivesuite/maven/docs/checkstyle/index.html
PMD-report
PMD-report: http://kb-prod-udv-001.kb.dk/netarchivesuite/maven/docs/pmd-report.html