[ofbiz-plugins] 01/02: Documented: ofbiz-plugins / ProjectMgr, migration of docbook help files to asciidoc, most of files have been directly included in project-mgr.adoc. (OFBIZ-11587)

[ho...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

holivier pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-plugins.git

commit 8d6c36b624064e41526649e1bf7b0b6612f91b9d
Author: holivier <ho...@apache.org>
AuthorDate: Fri May 1 18:31:40 2020 +0200

    Documented: ofbiz-plugins / ProjectMgr, migration of docbook help files
    to asciidoc, most of files have been directly included in
    project-mgr.adoc. (OFBIZ-11587)
---
 docs/asciidoc/plugins-user-manual.adoc             |  3 +
 .../src/docs/asciidoc/_include/prjm_intro.adoc     | 72 +++++++++++++++++++
 .../src/docs/asciidoc/_include/prjm_project.adoc   | 64 +++++++++++++++++
 projectmgr/src/docs/asciidoc/project-mgr.adoc      | 80 ++++++++++++++++++++++
 4 files changed, 219 insertions(+)

diff --git a/docs/asciidoc/plugins-user-manual.adoc b/docs/asciidoc/plugins-user-manual.adoc
index 7803615..789622e 100644
--- a/docs/asciidoc/plugins-user-manual.adoc
+++ b/docs/asciidoc/plugins-user-manual.adoc
@@ -34,3 +34,6 @@ include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1]
 include::../../ebaystore/src/docs/asciidoc/ebay-store.adoc[leveloffset=+1]
 
 include::../../myportal/src/docs/asciidoc/my-portal.adoc[leveloffset=+1]
+
+include::../../projectmgr/src/docs/asciidoc/project-mgr.adoc[leveloffset=+1]
+
diff --git a/projectmgr/src/docs/asciidoc/_include/prjm_intro.adoc b/projectmgr/src/docs/asciidoc/_include/prjm_intro.adoc
new file mode 100644
index 0000000..f705fce
--- /dev/null
+++ b/projectmgr/src/docs/asciidoc/_include/prjm_intro.adoc
@@ -0,0 +1,72 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+= Project Manager Introduction
+The project manager allows you to manage a project which in its simplest form consists out of phases and tasks.
+
+A project consists out of one or more phases of which each phase can have one or more tasks. +
+A task always has a single parentPhase. +
+Time registration is only done on a task level.
+
+Estimated and actual dates are only maintained at the task level. +
+For reporting they are calculated to the higher levels. +
+Project views are created to support this.
+
+== Status management
+Status is managed at task level, Project and Phase statuses shown on screen are tasks status compilation. +
+Task statuses are :
+
+|===
+| StatusId        | Status      |  Description
+| PTS_CREATED,    | Created     | after task creation
+| PTS_CREATED_UA  | Unassigned  | currently not used by an automatic process
+| PTS_CREATED_AS  | Assigned    | after a resource is assigned
+| PTS_CREATED_IP  | In Progress | after a time entry is created on the task
+| PTS_COMPLETED  .| Completed   |Manually changed by button
+| PTS_ON_HOLD     | On Hold     |
+| PTS_CANCELLED   |Cancelled    |
+|===
+
+Project or Phase is completed if all included tasks are completed (or cancelled)
+
+== Resources
+You can describe a customer (company and contact) and who provides the task (named provider) in the resource portlet.
+
+To be able to associate someone to a project he should have,  two (or more) project roleType, first PROJECT_TEAM to appear
+in Party drop-down, and at least one of the PROJECT_TEAM sub-roles for the second drop-down.
+
+Look at parameters section to have the complete project roletypes list.
+And go to the party profile to associate a role type to a party.
+
+== Parameters :
+* RoleType with PROJECT_TEAM as parentTypeId, used in a lot of screens; default proposed roleTypes are :
+** CLIENT% : used to select parties which appears in Projects Parties info, client side
+** CLIENT_MANAGER : user login associated to a project with this roleType view it in ListCustomerProjects
+** CLIENT_ANALYST : same as CLIENT_MANAGER for ListCustomerProjects
+** CLIENT_BILLING : partyId which will be invoiced; same as CLIENT_MANAGER for ListCustomerProjects; appears in Company part
+   of Project Parties info, other CLIENT% role appears in contact part
+** PROVIDER% : all parties which provide the project. In Projects Parties info, provider part, all roleType not equals to CLIENT%
+   will appear
+** PROVIDER_MANAGER : currently no process or specific selection
+** PROVIDER_ACCOUNTING : currently no process or specific selection
+** PROVIDER_ANALYST : currently no process or specific selection
+** PROVIDER_FUNCTIONAL : currently no process or specific selection
+** PROVIDER_VALIDATOR or PROVIDER_TESTER: used to define at project level who will validate a task,  used when assigning a party
+   to a task with status not equals to "PAS_COMPLETED", if the party has not this role, all parties with this role at the project
+   level will be added to this task. +
+   (this action is done by ECA, commented in default configuration, if you want it un-comment it)
diff --git a/projectmgr/src/docs/asciidoc/_include/prjm_project.adoc b/projectmgr/src/docs/asciidoc/_include/prjm_project.adoc
new file mode 100644
index 0000000..b986246
--- /dev/null
+++ b/projectmgr/src/docs/asciidoc/_include/prjm_project.adoc
@@ -0,0 +1,64 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+= Project - summary
+This dashboard gives a one page overview of project details, resources, phases and task.
+It is also the starting point to navigate to the various sub screens related to a project.
+
+== Sub screens
+Following sub screens are provided:
+
+* Gantt chart
+* Mailing List
+* Phases
+* Tasks
+* Orders
+* Resources
+* Content
+* Notes
+* Sub projects
+* Billing
+
+== Project Information
+This section provides detailed information about the project, e.g.
+the type and scope, the description and planned and actual start and end dates  and planned and actual hours
+
+== Resources
+This section provides detailed information about the participants (organizations and persons) of the project.
+For the participating persons this section provides information regarding the role in the project and the hours registered
+ and processed.
+
+== Sub projects
+This section provides detailed information about the project that are registered as sub projects of the project.
+
+== Phases
+This section provides an overview of the phases of the project, incl.
+status, priority, start and end date and the hours planned and registered.
+
+== Task
+This section provides provides an overview of the tasks of the project, incl.
+status, priority, start and end date, the first assigned resource and hours planned and registered.
+
+== Notes
+This section provides detailed information about notes registered with the project.
+
+== Content
+This section provides an overview of content (documents and other files)registered with the project.
+
+== Orders
+This section provides an overview of orders linked to the project.
\ No newline at end of file
diff --git a/projectmgr/src/docs/asciidoc/project-mgr.adoc b/projectmgr/src/docs/asciidoc/project-mgr.adoc
new file mode 100644
index 0000000..5a83d4c
--- /dev/null
+++ b/projectmgr/src/docs/asciidoc/project-mgr.adoc
@@ -0,0 +1,80 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+= Project Manager
+:doctype: book
+:sectnums:
+:toc: left
+:icons: font
+:experimental:
+:sourcedir: .
+
+include::_include/prjm_intro.adoc[leveloffset=+1]
+
+== ProjectMgr in UI
+=== Main screen.
+This is the startup screen of the project manager.
+It will show all active projects with some statistical data.
+
+=== My tasks
+This overview outlines all tasks the user has been assigned to.
+
+=== My Timesheets
+Here the user enters the hours worked on tasks.
+
+It also provides an overview of all timesheets the user has filled out. +
+It also shows the status of the timesheets.
+
+=== Find Projects
+This screen provides an overview of all projects the user is participating in.
+
+include::_include/prjm_project.adoc[leveloffset=+2]
+
+=== Project - billing
+This screen shows all hours registered to the various tasks in the project by all participants.
+
+From here the Project Manager processes all time entries for further processing regarding invoicing and
+cost accounting.
+
+=== Project - edit info
+The Project Manager can edit various details regarding the project.
+
+=== Project - orders
+This screen provides an overview of all orders related to the project.
+
+=== Project - phases
+This screen provides an overview of the phases of the project.
+
+The Project Manager can manage all phases in the project here, e.g. defining new phases.
+
+=== Project - resources
+This screen provides an overview of all participants in the project.
+
+From here the Project Manager can add new resources to the project, or end the participation of existing project members.
+
+=== Project - tasks
+This screen provides an overview of all tasks associated to the project.
+
+=== Project - Requests
+This screen provides an overview of all customer request regarding projects.
+
+=== Tasks
+This screen provides an overview of all tasks in the module
+
+=== Timesheets
+This screen provides an overview of all timesheets registered with the application by all project participants.