NetarchiveSuite|
⇤ ← Revision 1 as of 2009-05-26 12:16:18
Size: 7684
Comment: Created by the PackagePages action.
|
← Revision 2 as of 2010-08-16 10:25:10 ⇥
Size: 7708
Comment: converted to 1.6 markup
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| [[TableOfContents]] | <<TableOfContents>> |
| Line 6: | Line 6: |
| The ["Developer Manual"] is the main piece of description of how to contribute. 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. | The [[Developer Manual]] is the main piece of description of how to contribute. 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. |
| Line 8: | Line 8: |
| If you have technical or general questions about the use of the tools, you are welcome to contact us via [[MailTo(netarchivesuite-users AT lists DOT gforge DOT statsbiblioteket DOT dk)]][[FootNote(You need to be logged in to !NetarchiveSuite in order to see mail addresses properly)]]. You can subscribe to the mailing list [https://lists.gforge.statsbiblioteket.dk/mailman/listinfo/netarchivesuite-users here] |
If you have technical or general questions about the use of the tools, you are welcome to contact us via <<MailTo(netarchivesuite-users AT lists DOT gforge DOT statsbiblioteket DOT dk)>><<FootNote(You need to be logged in to !NetarchiveSuite in order to see mail addresses properly)>>. You can subscribe to the mailing list [[https://lists.gforge.statsbiblioteket.dk/mailman/listinfo/netarchivesuite-users|here]] |
| Line 11: | Line 11: |
| If you want mails on announcement of releases, change in roadmap, events etc., you are welcome to subscribe to the mailing list [[MailTo(netarchivesuite-announce AT lists DOT gforge DOT statsbiblioteket DOT dk)]][[FootNote(You need to be logged in to !NetarchiveSuite in order to see mail addresses properly)]]. You can subscribe to the mailing list [https://lists.gforge.statsbiblioteket.dk/mailman/listinfo/netarchivesuite-announce here] |
If you want mails on announcement of releases, change in roadmap, events etc., you are welcome to subscribe to the mailing list <<MailTo(netarchivesuite-announce AT lists DOT gforge DOT statsbiblioteket DOT dk)>><<FootNote(You need to be logged in to !NetarchiveSuite in order to see mail addresses properly)>>. You can subscribe to the mailing list [[https://lists.gforge.statsbiblioteket.dk/mailman/listinfo/netarchivesuite-announce|here]] |
| Line 14: | Line 14: |
| Alternatively, technical questions can be posted to the [https://gforge.statsbiblioteket.dk/forum/forum.php?forum_id=6 developer forum]. | Alternatively, technical questions can be posted to the [[https://gforge.statsbiblioteket.dk/forum/forum.php?forum_id=6|developer forum]]. |
| Line 17: | Line 17: |
| To follow the latest developments, go to [https://gforge.statsbiblioteket.dk/scm/?group_id=7 the SVN repository], which contains [https://gforge.statsbiblioteket.dk/plugins/scmsvn/viewcvs.php/trunk/?root=netarchivesuite latest updates of code] and [https://gforge.statsbiblioteket.dk/tracker/?group_id=7 bugs, patches and feature requests] | To follow the latest developments, go to [[https://gforge.statsbiblioteket.dk/scm/?group_id=7|the SVN repository]], which contains [[https://gforge.statsbiblioteket.dk/plugins/scmsvn/viewcvs.php/trunk/?root=netarchivesuite|latest updates of code]] and [[https://gforge.statsbiblioteket.dk/tracker/?group_id=7|bugs, patches and feature requests]] |
| Line 19: | Line 19: |
| To see the latest releases go to [:Get NetarchiveSuite:registration and download] | To see the latest releases go to [[Get NetarchiveSuite|registration and download]] |
| Line 23: | Line 23: |
| !NetarchiveSuite supports [:Development/Plugins:plug-ins] in the form of specifying class files to use for particular parts. We intend to expand the number of places plug-ins can be used and the way they can be configured. | !NetarchiveSuite supports [[Development/Plugins|plug-ins]] in the form of specifying class files to use for particular parts. We intend to expand the number of places plug-ins can be used and the way they can be configured. |
| Line 25: | Line 25: |
| !NetarchiveSuite [:Development/Settingsstructure:settings structure] has been discussed. Basically the current structure of settings is difficult to use and does not meet our needs. | !NetarchiveSuite [[Development/Settingsstructure|settings structure]] has been discussed. Basically the current structure of settings is difficult to use and does not meet our needs. |
| Line 29: | Line 29: |
| * [:AssignmentGroupB2:Assignment Group B.2] Improve and isolate bit preservation GUI. * [:AssignmentGroupB4:Assignment Group B.4] Improve batch job architecture |
* [[AssignmentGroupB2|Assignment Group B.2]] Improve and isolate bit preservation GUI. * [[AssignmentGroupB4|Assignment Group B.4]] Improve batch job architecture |
| Line 40: | Line 40: |
| Please refer to [:Iteration35TaskList:Iteration 35 Task List] | Please refer to [[Iteration35TaskList|Iteration 35 Task List]] |
| Line 43: | Line 43: |
| <to be implemented in a new tool, currently represented on internal wiki> [[BR]] | <to be implemented in a new tool, currently represented on internal wiki> <<BR>> |
| Line 46: | Line 46: |
| Please also refer to the [:Code_Review_Process:Code Review Process] for more information about the related process. | Please also refer to the [[Code_Review_Process|Code Review Process]] for more information about the related process. |
| Line 49: | Line 49: |
| <to be transfered from old wiki or implemented in new tool at a later stage> [[BR]] | <to be transfered from old wiki or implemented in new tool at a later stage> <<BR>> |
| Line 67: | Line 67: |
| Please refer to the [:Code_Review_Process:Code Review Process]. | Please refer to the [[Code_Review_Process|Code Review Process]]. |
| Line 80: | Line 80: |
| 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. | 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. |
| Line 83: | Line 83: |
| There are several things to do when we make a release. Please see the page on [:ReleaseProcedures:Release Procedures] for further information. | There are several things to do when we make a release. Please see the page on [[ReleaseProcedures|Release Procedures]] for further information. |
| Line 86: | Line 86: |
| Please refer to the [:BugInfGuide:bug information guideline] | Please refer to the [[BugInfGuide|bug information guideline]] |
| Line 92: | Line 92: |
| [http://netarchive.dk/apidocs/ Javadocs all versions] | [[http://netarchive.dk/apidocs/|Javadocs all versions]] |
Contents
The NetarchiveSuite system is continuously under development at the Royal Library and the State Library in Denmark. While we have our own priorities and needs in connection with our harvests, we are interested in working together with other users to improve the system.
Communication
The Developer Manual is the main piece of description of how to contribute. 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.
If you have technical or general questions about the use of the tools, you are welcome to contact us via <netarchivesuite-users AT lists DOT gforge DOT statsbiblioteket DOT dk>1. You can subscribe to the mailing list here
If you want mails on announcement of releases, change in roadmap, events etc., you are welcome to subscribe to the mailing list <netarchivesuite-announce AT lists DOT gforge DOT statsbiblioteket DOT dk>1. You can subscribe to the mailing list here
Alternatively, technical questions can be posted to the developer forum.
Repository
To follow the latest developments, go to the SVN repository, which contains latest updates of code and bugs, patches and feature requests
To see the latest releases go to registration and download
Projects in pipeline and current
Design Discussions
NetarchiveSuite supports plug-ins in the form of specifying class files to use for particular parts. We intend to expand the number of places plug-ins can be used and the way they can be configured.
NetarchiveSuite settings structure has been discussed. Basically the current structure of settings is difficult to use and does not meet our needs.
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.
Assignment Group B.2 Improve and isolate bit preservation GUI.
Assignment Group B.4 Improve batch job architecture
Requirement list
<to be transfered from old wiki>
Staffing
<to be transfered from old wiki>
Iterations
Current Iteration Task overview
Please refer to Iteration 35 Task List
Current Code Reviews
<to be implemented in a new tool, currently represented on internal wiki>
Current Code Reviews (not open): http://kb-prod-udv-001.kb.dk/twiki/bin/view/Netarkiv/Iteration35ReviewsOversigt
Please also refer to the Code Review Process for more information about the related process.
Current Release Test
<to be transfered from old wiki or implemented in new tool at a later stage>
Current Release Test (not open): http://kb-prod-udv-001.kb.dk/twiki/bin/view/Netarkiv/Iteration35ReleaseTest
Old Iterations (incl. Test, reviews)
Will in the future contain summries of previous iterations
Development Methodology
<This needs to be translated and moved from the old wiki>
Methodology
<This needs to be translated and moved from the old wiki - there are a lot more sections than the below indeicated sections>
Roles
The methodology refers to different roles like QA, Component Owner, ... These must be explained in the following.
<This needs to be translated and moved from the old wiki>
Code Reviews
Please refer to the Code Review Process.
NOTE: the process needs to be adjusted to introduction of a tool that can assist in the Code Review Process.
Component bugs
Implementation especially concerning bug fixes is focused through the processes for Component bugs.
<This needs to be translated and moved from the old wiki>
Guidelines & Policies
<There are still more sections than the below indicated sections which needs to be moved from the old to the new wiki>
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.
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
Generated reports
Currently most generated reports are placed on a server that are not accesable to the outside. This will be changed when the information is moved to a public accessable server.
JavaDocs all versions
Source Xref/log
Currently this is on a server not accesable to the outside. This will be changed when the information is moved to a public accessable server.
Source Xref (not open): https://kb-prod-udv-001.kb.dk/internetbevaring/docs/xref/
Log (not open): http://kb-prod-udv-001.kb.dk/maven-current-iteration-output.txt
Bug statistics
Currently this is on a server not accesable to the outside. This will be changed when the information is moved to a public accessable server.
Bug statistics (not open): http://kb-prod-udv-001.kb.dk/twiki/bin/view/Netarkiv/StatisticsBugComponentNew
Findbugs-report
Currently this is on a server not accesable to the outside. This will be changed when the information is moved to a public accessable server.
Findbugs-report (not open): https://kb-prod-udv-001.kb.dk/internetbevaring/docs/findbugs-report.html
Findbugs help: http://findbugs.sourceforge.net/bugDescriptions.html
Clover-report
Currently this is on a server not accesable to the outside. This will be changed when the information is moved to a public accessable server.
Clover-report (not open): http://kb-prod-udv-001.kb.dk/clover/clover_current/
Checkstyle-report (maven)
Currently this is on a server not accesable to the outside. This will be changed when the information is moved to a public accessable server.
Checkstyle-report (not open): http://kb-prod-udv-001.kb.dk/internetbevaring/docs/checkstyle/index.html
PMD-report
Currently this is on a server not accesable to the outside. This will be changed when the information is moved to a public accessable server.
PMD-report (not open): https://kb-prod-udv-001.kb.dk/internetbevaring/docs/pmd-report.html
Unittest exclusions
Currently this is on a server not accesable to the outside. This will be changed when the information is moved to a public accessable server.
Unittest exclusions (not open): https://kb-prod-udv-001.kb.dk/qa/runningAs.txt