From 7e8b13734c272a8f0068049f885fb49954733447 Mon Sep 17 00:00:00 2001 From: Manuel Rego Casasnovas Date: Wed, 15 Dec 2010 10:31:42 +0100 Subject: [PATCH] Updating several information files. * README: Updated content. * INSTALL: Updated content. * TODO: Added planned features for future releases. * HACKING: Added basic file with link to wiki. FEA: ItEr65S04CommnityMaterialItEr64S09 --- HACKING | 7 +++++ INSTALL | 65 ++++++++++++++++++++-------------------- README | 54 +++++++++++++++++---------------- TODO | 92 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 160 insertions(+), 58 deletions(-) create mode 100644 HACKING diff --git a/HACKING b/HACKING new file mode 100644 index 000000000..b81ad5b0b --- /dev/null +++ b/HACKING @@ -0,0 +1,7 @@ +Hacking +======= + +If you want to hack on the *NavalPlan* project you should visit the wiki where +you can find all the information related with project development. + +*NavalPlan* wiki is available at: http://wiki.navalplan.org/. diff --git a/INSTALL b/INSTALL index 6d310ef8d..ab2d7f920 100644 --- a/INSTALL +++ b/INSTALL @@ -5,8 +5,7 @@ Installation instructions Database creation ----------------- -* Current databases supported: PostgreSQL (default), MySQL, and HSQLDB - (In-Process/Standalone Mode). +* Current databases supported: PostgreSQL (default) and MySQL. * For PostgreSQL and MySQL: @@ -34,13 +33,13 @@ Database creation GRANT ALL ON navaldev.* to 'naval'@'localhost' identified by 'naval'; GRANT ALL ON navaldevtest.* to 'naval'@'localhost' identified by 'naval'; - - For HSQLDB. There is nothing to do. - Compilation ----------- - cd xestion-producion +* Execute the following commands:: + + cd navalplan mvn install @@ -64,12 +63,6 @@ Compilation e.g. mvn -Pdev,mysql install - + HSQLDB: - - - Use ``mvn -Pdev,hsqldb <>``:: - - e.g. mvn -Pdev,hsqldb install - Profiles -------- @@ -79,41 +72,47 @@ approach used in the project. The default profiles (the one assumed by the above instructions) are ``dev`` and ``postgresql`` (meaning "use PostgreSQL assuming a development environment"). + Print ----- -Printing system is based on a tool that produces several output formats rendering -the specified URLs with the WebKit engine. To be able to print local diagrams this -tool and a lightweight X server must be installed. +Printing system is based on a tool that produces several output formats +rendering the specified URLs with the WebKit engine. To be able to print local +diagrams this tool and a lightweight X server must be installed. -The capturing tool is CutyCapt [1], which has to be either compiled or installed from -an external package. Once compiled from the tarball the binary CutyCapt must be located -under /usr/bin/ to be available to the application. +The capturing tool is CutyCapt [1]_, which has to be either compiled or +installed from an external package. Once compiled from the tarball the binary +CutyCapt must be located under ``/usr/bin/`` to be available to the application. -X virtual framebuffer xvfb[2] package needs to be installed for the application running on -a non-desktop server is capable of launching an X instance to create the print capture of -the selected page. +X virtual framebuffer xvfb [2]_ package needs to be installed for the +application running on a non-desktop server is capable of launching an X +instance to create the print capture of the selected page. + +.. [1] http://cutycapt.sourceforge.net/ +.. [2] http://www.xfree86.org/4.0.1/Xvfb.1.html -[1] http://cutycapt.sourceforge.net/ -[2] http://www.xfree86.org/4.0.1/Xvfb.1.html User Documentation ------------------ -User documentation is done in *Reestructured Text*. It is necessary to have installed -the following packages: +User documentation is done in *reStructuredText*. It is necessary to have +installed the following packages: + + * ``automake`` package in order to be able to execute ``make``. + * ``python-docutils`` package version 0.4 or higher. + * ``texlive-latex-base`` package in order to have ``pdflatex`` available. - * automake package in order to be able to execute "make". - * "python-docutils" package version 0.4 or higher. - * "texlive-latex-base" package in order to have "pdflatex" available. Compilation ------------ +~~~~~~~~~~~ -The compilation is included in Maven build. If you execute "mvn install" documentation is generated. +The compilation is included in Maven build. If you execute ``mvn install`` +documentation is generated. -* For manual compilation, inside "doc/src/es", "doc/src/gl" or "doc/src/es" directories: - make html - make pdf +* For manual compilation, inside ``doc/src/es``, ``doc/src/gl`` or + ``doc/src/es`` directories: -* Output is created in "doc/src/es/html" and "/doc/src/es/pdf" directories. + make html + make pdf + +* Output is created in ``doc/src/es/html`` and ``/doc/src/es/pdf`` directories. diff --git a/README b/README index 0fd6509c3..dbb1b8fc6 100644 --- a/README +++ b/README @@ -5,34 +5,32 @@ NavalPlan Description ----------- +*NavalPlan* is a free software web application for project management. + *NavalPlan* is a planning tool for users based on some concepts: company and multi-project overview, criteria assignments, tasks tagging, resources -management, resource allocation (specific and generic) company load control, +management, resource allocation (specific and generic), company load control, external integration, etc. +Although its name is clearly related to shipbuilding, *Navalplan* is a fully +useful planning tool for any type of company whose workflow requires project and +order administration and scheduling. + Features ~~~~~~~~ -* Company and multi-project overview. -* Criteria management: Criteria are a system entity that enables resources - (both humans and machines) and tasks to be classified. -* Resources management: There are two different kinds: humans and machines. -* Resource allocation: One of the key points of the program is having the - possibility of two kinds of designation: specific and generic. Generic - allocation is based on criteria that are required to carry out a task and - must be fulfilled by resources that are capable of performing them. -* Calendars: Calendars determine the available productive hours for different - resources. The user may create general calendars for the company or input - characteristics for more specific calendars, meaning that calendars for - resources and tasks can be made. -* Labels: These are elements that are used to label project tasks. With these - labels, the user of the program can group tasks together according to - concept, which can then be checked at a later date as a group or after being - filtered. -* Orders and order elements: Work requested by clients is treated by the - application as an order, which is structured in order elements. The order and - its elements adhere to a hierarchical structure of undefined levels. This - element tree is the basis when planning work. +* Multiproject management. It offers a global vision of the company managing + several projects sharing resources. +* Group resource allocations: dynamic groups based on criteria. +* Flexible calendars. +* Configurable Gantt chart from Work Breakdown Structure (WBS) [1]_. +* Resource Breakdown Structure (RBS) chart [2]_. +* Overload resource allocation control. +* Earned Value Management [3]_. +* Cost analysis based on work reports. +* Integration with other *NavalPlan* instances and third-parties. +* Other functionalities: Materials, quality forms, project templates, planning + scenarios, multiple task progress measurement ... Requirements @@ -60,6 +58,9 @@ Webpage You can find more information about *NavalPlan* at http://www.navalplan.org/en/. +For information related with *NavalPlan* development you can visit the wiki at +http://wiki.navalplan.org/. + Reporting bugs -------------- @@ -71,7 +72,7 @@ License ------- *NavalPlan* is released under the terms of the GNU Affero General Public -License version 3 [1]_. +License version 3 [4]_. Please read the ``COPYING`` file for details. @@ -80,11 +81,14 @@ Authors ------- This project is sponsored by *Fundación para o Fomento da Calidade Industrial e -o Desenvolvemento Tecnolóxico de Galicia* [2]_. +o Desenvolvemento Tecnolóxico de Galicia* [5]_. Please see ``AUTHORS`` file for more information about the authors. -.. [1] http://www.fsf.org/licensing/licenses/agpl.html -.. [2] http://www.fundacioncalidade.org/ +.. [1] http://en.wikipedia.org/wiki/Work_Breakdown_Structure +.. [2] http://en.wikipedia.org/wiki/Resource_Breakdown_Structure +.. [3] http://en.wikipedia.org/wiki/Earned_Value_Management +.. [4] http://www.fsf.org/licensing/licenses/agpl.html +.. [5] http://www.fundacioncalidade.org/ diff --git a/TODO b/TODO index e69de29bb..1d13dc15a 100644 --- a/TODO +++ b/TODO @@ -0,0 +1,92 @@ +TODO +==== + +Version 1.0 - 2011w1 +-------------------- + +Dates +~~~~~ + +* *Feature freeze*: 2010w50 +* *Release date*: 2011w1 + +Main features +~~~~~~~~~~~~~ + +* Multiproject management. It offers a global vision of the company managing + several projects sharing resources. +* Group resource allocations: dynamic groups based on criteria. +* Flexible calendars. +* Configurable Gantt chart from Work Breakdown Structure (WBS). +* Resource Breakdown Structure (RBS) chart. +* Overload resource allocation control. +* Earned Value Management (EVM). +* Cost analysis based on work reports. +* Integration with other *NavalPlan* instances and third-parties. +* Other functionalities: materials, quality forms, project templates, planning + scenarios, multiple task progress measurement ... + +Latest features +~~~~~~~~~~~~~~~ + +* Backwards planning with new restrictions (AS_LATE_AS_POSSIBLE and + FINISH_NOT_LATER_THAN). +* Two direction resource allocation schemes. Forwards and backwards strategies + supported depending on Gantt conditions. +* Time unit inferior to hours in calendars. Minutes and seconds are allowed. +* Limiting resources. Appropriative insertion algorithm with task scrolling. +* Monte Carlo technique for project duration simulation. Duration probability + functions are calculated based on likelihood estimations. +* Sigmoid advance resource allocation function approaching what happens in real + world. +* Monitorization of project progress based on critical path progresses. +* Human readable codes generation for data. +* Configurable display of advances and cost in planning tasks. +* Database migration support. Automatic management of database refactorings + keeping former data. + + +Version 1.1 - 2011w14 +--------------------- + +Dates +~~~~~ + +* *IRC coordination meeting*: 2011w2 +* *Feature freeze*: 2011w11 +* *Release date*: 2011w14 + +Features +~~~~~~~~ + +* Improve printing support. +* Possibility of using critical chain paradigm in project planning. +* Resource levelling. +* General allocation resource allocation improvements: reduction of + fragmentation in distributing allocation algorithm and heuristic to use same + resources over a period. +* Performance improvements: resource load view and Gantt view. +* Chromium browser completely supported. + + +Future +------ + +* Disable complex features by default. +* Quick start wizard. +* Add export/import for different format files from other projects like + OpenProj, MicrosoftProject, ... +* Provide examples for integration services that don't depend on Ruby (maybe + directly with Java). +* Migrate to ZK 5. + + +Wish List +--------- + +* Customization (e.g. recently opened projects in menu). +* Database snapshot with example data. +* Unit tests for integration services using truly HTTP requests and XML files. +* Auto-deployable executable. Application is downloaded and installed with JNLP + (Java Web Start) and on starting launches an embedded servlet container in + which it is executed. It will include a pure Java database like HSQLDB too.