diff --git a/docs/getting-started/projects/README.md b/docs/getting-started/projects/README.md index 30c7e77dc2..1773277bcb 100644 --- a/docs/getting-started/projects/README.md +++ b/docs/getting-started/projects/README.md @@ -13,31 +13,31 @@ Get an introduction how to work with projects in OpenProject. To start collabora
A **project** is defined as a temporary, goal-driven effort to create a unique output. A project has clearly defined phases, a start and an end date, and its success is measured by whether it meets its stated objectives. A project in OpenProject can be understood as a project as defined above. Also, it can be set up as a "workspace" for teams to collaborate on one common topic, e.g. to organize a department. - -| Feature | Documentation for | -| ------------------------------------------------------- | ----------------------------------------------------- | -| [Open project](#open-an-existing-project) | Select and open an existing project. | -| [Create a new project](#create-a-new-project) | How to create a new project? | -| [View all projects](#view-all-projects) | How to get an overview about all my projects? | -| [Advanced project settings](#advanced-project-settings) | Configure further advanced settings for your project. | + +| Topic | Content | +| ------------------------------------------------------- | ------------------------------------------------------------ | +| [Open project](#open-an-existing-project) | Select and open an existing project. | +| [Create a new project](#create-a-new-project) | Create a project from scratch or use existing project templates. | +| [View all projects](#view-all-projects) | Get an overview about all your projects. | +| [Advanced project settings](#advanced-project-settings) | Configure further advanced settings for your project. | ## Open an existing project -In order to open an existing project, click on the **Select a project** button on the top left corner of the header, and click the project which you want to open. +In order to open an existing project, click the **Select a project** button in the upper left corner of the header and select the project you want to open. -You can also start typing in a project name to filter for the project's title. +You can also start typing in a project name to filter by the project's title. ![open project](1572877683380.png) -Project and subproject are displayed according to their hierarchy in the drop-down menu. +Projects and subprojects are displayed according to their hierarchy in the drop-down menu.
**Subproject** is definded as a child project of another project. Subprojects can be used to display a hierarchy of projects. Several filter options (e.g. in work package list and timeline) can be applied only to the current project and its subprojects. @@ -61,22 +61,23 @@ Also, you can click the green button **+ Project** directly on the system's home ![Create-project-home-screen](Create-project-home-screen.png) -- You can either create a completely new project or create a project from a template. Therefore, choose a template using the drop-down menu. +- You can either create a completely new project, create a subproject of an existing project or create a (sub)project from a template. For the latter option, choose a template using the drop-down menu. - Enter a **name** for your project and click the blue **Create** button. +- The **Advanced Settings** allow for further configuration, e.g. description, URL, etc. ![image-20200921122508132](image-20200921122508132.png) -Now, you can get started working in your project. +Now, you can get started working on your project. To configure further project information, see the [advanced settings](#TODO) section in the project admin guide. ### View all projects -To view all your projects where you are a member, click on the **View all projects** link on the Select a project drop-down menu. +To view all your projects in which you are a member, click on the **View all projects** link in the **Select a project** drop-down menu. ![view all proejcts](1569490429831.png) -You will see a list with all your projects and its details. +You will see a list with all your projects and their details. ![view all projects](1569490488827.png) diff --git a/docs/user-guide/gantt-chart/README.md b/docs/user-guide/gantt-chart/README.md index 81d557a132..102cb6a028 100644 --- a/docs/user-guide/gantt-chart/README.md +++ b/docs/user-guide/gantt-chart/README.md @@ -64,7 +64,7 @@ In the menu, choose **Add predecessor** or **Add follower**. Select the item which you want to create the dependency with. The precede and follow relation is marked with a small blue line in the Gantt chart. -OpenProject does not yet include a baseline feature to compare scheduled versions. However, we are aware of the need for it and documented it. Please check [here](https://community.openproject.com/projects/openproject/work_packages/26448/activity)for an update. +OpenProject does not yet include a baseline feature to compare scheduled versions. However, we are aware of the need for it and documented it. Please check [here](https://community.openproject.com/projects/openproject/work_packages/26448/activity) for an update. ![dependencies-gantt-chart](dependencies-gantt-chart-1566556144225.gif) diff --git a/docs/user-guide/integrations/README.md b/docs/user-guide/integrations/README.md index 4486e30ca6..8190df66af 100644 --- a/docs/user-guide/integrations/README.md +++ b/docs/user-guide/integrations/README.md @@ -17,30 +17,29 @@ We are prioritizing this topic at the moment and will update this guide with the ## Jira -Currently, there is no direct integration between OpenProject and Jira. Since OpenProject is an excellent open source alternative to Jira, we have prepared a way to import tickets from Jira to OpenProject. First, you can export your tasks from Jira into an Excel file and then import these tasks via an [Excel plugin into OpenProject](https://www.openproject.org/synchronize-excel-openproject/). +Currently, there is no direct integration between OpenProject and Jira. Since OpenProject is an excellent open source alternative to Jira, we have prepared a way to import tickets from Jira to OpenProject. First, you can export your tasks from Jira into an Excel file and then import these tasks via an [Excel plugin into OpenProject](./Excel Synchronization). If you would like to learn more about the features of **OpenProject vs Jira** please read [here](https://www.openproject.org/jira-alternative/). ## Microsoft Project There is an integration between MS Project and OpenProject. However, the synch plugin is not actively maintained at this time. If you wish to find out more, please [contact us](https://www.openproject.org/contact-us/). -To synchronize tasks from MS Project to OpenProject, you can export your MS Project file to Excel and then [synchronize it with OpenProject]( https://www.openproject.org/synchronize-excel-openproject/). -Here are some (German) videos how to synchronize Excel with OpenProject: https://youtu.be/kL4u7ew0yHk +To synchronize tasks from MS Project to OpenProject, you can export your MS Project file to Excel and then [synchronize it with OpenProject]( ./Excel Synchronization). ## Trello -Currently, there is no direct integration between OpenProject and Trello. To synchronize tasks from Trello to OpenProject, export your tasks from Trello into an Excel file and then import these tasks via an [Excel plugin into OpenProject](https://www.openproject.org/de/synchronize-excel-openproject/). +Currently, there is no direct integration between OpenProject and Trello. To synchronize tasks from Trello to OpenProject, export your tasks from Trello into an Excel file and then import these tasks via an [Excel plugin into OpenProject](./Excel Synchronization). If you would like to learn more about OpenProject's features vs Trello, please read [here](https://www.openproject.org/trello-alternative/). ## Toggl -We do offer an integration between OpenProject and the [time tracking app toggl](../time-and-costs/time-tracking/toggl-integration/). +We do offer an [integration](../time-and-costs/time-tracking/toggl-integration/) between OpenProject and the time tracking app Toggl. ## Slack -We do offer a rudimentary OpenProject Slack integration. -[Get in touch to find out more](https://www.openproject.org/contact-us/). +There is a rudimentary OpenProject Slack integration. It messages a configured Slack channel, every time a Work Package or Wiki site is modified. This integration is not officially supported by OpenProject. +To activate it in the Cloud Edition please [get in touch](https://www.openproject.org/contact-us/). For the Enterprise Edition and the Cloud Edition you can find the plugin and its documentation on GitHub: [OpenProject Slack plugin](https://github.com/opf/openproject-slack#openproject-slack-plugin) ## Timesheet Currently, there is no direct integration between OpenProject and Timesheet. If you are looking for a time tracking tool with a simple oush of a button, consider the integration with [Toggl](../time-and-costs/time-tracking/toggl-integration/). diff --git a/docs/user-guide/projects/README.md b/docs/user-guide/projects/README.md index 7d41db36c7..98fea5e857 100644 --- a/docs/user-guide/projects/README.md +++ b/docs/user-guide/projects/README.md @@ -12,21 +12,21 @@ In OpenProject you can create projects to collaborate with your team members, tr Your projects can be available publicly or internally. OpenProject does not limit the number of projects, neither in the Community nor in the Cloud or Enterprise Edition. -| Topic | Content | +| Topic | Content | | ------------------------------------------------------------ | ------------------------------------------------------------ | | [Select a project](../../getting-started/projects/) | Open a project which you want to work at. | | [Create a new project](../../getting-started/projects/#create-a-new-project) | Find out how to create a new project in OpenProject. | +| [Create a subproject](#create-a-subproject) | Create a subproject of an existing project. | | [Project structure](#project-structure) | Find out how to set up a project structure. | | [Project settings](#project-settings) | Configure further settings for your projects, such as description, project hierarchy structure, or setting it to public. | -| [Change the project hierarchy](#change-the-project-hierarchy) | You can change the hierarchy by selecting the parent parent (subproject of). | -| [Set a project to public](#set-a-project-to-public) | Set a project to public to have it accessible without signing-in. | -| [Set a project as template](#set-a-project-as-template) | Set a project as template to copy it for future projects. | -| [Copy a template project](#copy a template project) | Create a new project based on an existing template project. | +| [Change the project hierarchy](#change-the-project-hierarchy) | You can change the hierarchy by selecting the parent project ("subproject of"). | +| [Set a project to public](#set-a-project-to-public) | Make a project accessible for (at least) all users within your instance. | +| [Create a project template](#create-a-project-template) | Configure a project and set it as template to copy it for future projects. | +| [Use a project template](#use-a-project-template) | Create a new project based on an existing template project. | | [Copy a project](#copy-a-project) | Copy an existing project. | | [Archive a project](#archive-a-project) | Find out how to archive completed projects. | | [Delete a project](#delete-a-project) | How to delete a project? | | [View all projects](#view-all-projects) | Get an overview of all your projects in the project overview list. | -| [Create a project template](#create-a-project-template) | You can create a project template and use it for future projects. | | [Project overarching reports](#project-overarching-reports) | How to create project overarching reports across multiple projects? | ## Select a project @@ -37,13 +37,13 @@ Find out in our Getting started guide [how to open an existing project](../../ge Find out in our Getting started guide how to [create a new project](../../getting-started/projects/#create-a-new-project) in OpenProject. -## Create subproject +## Create a subproject -To create a subproject for an existing project, navigate to the [project settings](#project-settings) -> *Information* and click on the green + Subproject button. +To create a subproject for an existing project, navigate to the [project settings](#project-settings) -> *Information* and click on the green **+ Subproject** button. Follow the instructions to [create a new project](../../getting-started/projects/#create-a-new-project). -![Create-subproject](Create-subproject.png) +![image-20200921153208651](image-20200921153208651.png) ## Project structure @@ -115,22 +115,39 @@ Press the blue **Save** button to apply your changes. ### Set a project to public -If you want to set a project to public, you can do so by selecting the option in the [project settings](project-settings). +If you want to set a project to public, you can do so by ticking the box next to "Public" in the [project settings](project-settings) *->Information*. +Setting a project to public will make it accessible to all people within your OpenProject instance. +(Should your instance be accessible without authentication [accessible without authentication](../../system-admin-guide/authentication/authentication-settings) this option will make the project visible to the general public outside your users, too) -### Set a project as template -You can set a project as template for similiar projects in the future by navigating to the [project settings](project-settings) and clicking **Set as template** in the upper right corner. You can remove a project from the template collection on the same spot. +### Create a project template + +You can create a project template in OpenProject by [creating a new project](../../getting-started/#create-a-project) and configuring your project to your needs. Name the project so you can identify it as a template, e.g. "Project XY [template]". + +Set up everything that you want to have available for future projects. + +- Adding project members. +- Selecting the modules. +- Setting up a default project structure in the Gantt chart. +- Creating your work package templates. +- ... + +Navigate to the [project settings](project-settings) and click **Set as template** in the upper right corner. You can remove a project from the template collection on the same spot. + - + + + ![image-20200921120538872](image-20200921120538872.png) -### Copy a template project +### Use a template project -You can create a new project by copying an existing template. Find out in our Getting started guide how to [create a new project](../../getting-started/projects/#create-a-new-project) in OpenProject. +You can create a new project by using an existing template. This causes the properties of the project template to be copied to the new project. Find out in our Getting started guide how to [create a new project](../../getting-started/projects/#create-a-new-project) in OpenProject. +Another way for using a template project would be to [copy it](#copy-a-project). ### Copy a project @@ -184,20 +201,6 @@ With the **three dots** icon at the right in the list you can open further featu In the view all projects overview list you can also create a multi project status dashboard if you include [project custom fields](../../system-admin-guide/custom-fields/custom-fields-projects/), such as Status, Status description, Accountable, Project duration, and more. -## Create a project template - -You can create a project template in OpenProject by [creating a new project](../../getting-started/#create-a-project) and configure your project to your needs. Name the project so you can identify it as a template, e.g. Project template. - -Set up everything that you want to have available for next projects. - -- Adding project members. -- Selecting the modules. -- Setting up a default project structure in the Gantt chart. -- Creating your work package templates. -- ... - -[Copy the project](#copy-a-project) template if you want to start a new project and give the project a new name. - ## Project overarching reports Often you need to see more than one project in your lists and want to create project overarching reports. diff --git a/docs/user-guide/projects/image-20200921153208651.png b/docs/user-guide/projects/image-20200921153208651.png new file mode 100644 index 0000000000..20fdc5398f Binary files /dev/null and b/docs/user-guide/projects/image-20200921153208651.png differ diff --git a/docs/user-guide/projects/project-settings/project-information/README.md b/docs/user-guide/projects/project-settings/project-information/README.md index cef271897e..73af8b6a96 100644 --- a/docs/user-guide/projects/project-settings/project-information/README.md +++ b/docs/user-guide/projects/project-settings/project-information/README.md @@ -27,6 +27,7 @@ You will have the following options in the project settings. 11. **Create a new subproject** for this project with the green **+ Subproject** button. 12. **Copy the project**. When [copying a project](../../#copy-a-project) you can choose which modules you will copy. 13. **Archive a project**. This way the [archived project](../../#archive-a-project) will not appear in the project selection anymore and cannot be accessed by team members. You can view archived projects in the view all projects list. -14. **Delete a project**. By [deleting a project](../../#delete-a-project) the whole project will all included information will be removed. +14. **Set as template** or **Remove from templates**. By [setting a project as template](../../#create-a-project-template) it can be copied multiple times to create similar projects. +15. **Delete a project**. By [deleting a project](../../#delete-a-project) the whole project with all included information will be removed. ![User-guide_project-settings](User-guide_project-settings.png) \ No newline at end of file