Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs changes #11615

Merged
merged 3 commits into from
Nov 11, 2022
Merged

Docs changes #11615

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5fef831
Small changes to docs
birthe Nov 10, 2022
d5f9f42
Update docs
birthe Nov 11, 2022
120e13a
Remove premium feature from header
birthe Nov 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions docs/user-guide/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@ keywords: user guide

Welcome to the OpenProject User guide.

This guide covers all of OpenProject's functionalities.


This guide covers all of OpenProject's functionalities from a user's perspective.

## Overview of projects in OpenProject

Expand All @@ -24,7 +22,7 @@ Both the community edition and enterprise edition allow you to create an unlimit
<div class="glossary">
**Module** is defined as an independent unit of functionality that can be used to extend and improve the existing core functions.</div>

Within a project Modules can be activated and deactivated under "Modules" in the project settings menu by project members who have sufficient permissions to adjust project settings. Which modules will be available within projects is controlled in the global Administration settings (please see [System admin guide](.../system-admin-guide/system-settings/project-system-settings/) to see how this is done.)
Within a project Modules can be activated and deactivated under "Modules" in the project settings menu by project members who have sufficient permissions to adjust project settings. Which modules will be available within projects is controlled in the global Administration settings (please see [System admin guide](.../system-admin-guide/system-settings/project-system-settings/) to see how this is done).

Please choose the module or topic you want to learn more about.

Expand All @@ -38,7 +36,7 @@ Please choose the module or topic you want to learn more about.
| [Calendar](calendar) | How to display your work in a calendar in OpenProject. |
| [Documents](documents) | How to upload and share documents in OpenProject. |
| [Forums](forums) | How to manage forums to discuss and comment on topics. |
| [GitHub](../system-admin-guide/integrations/github-integration/) | How to manage GitHub integration. |
| [GitHub](../system-admin-guide/integrations/github-integration/) | How to manage the GitHub integration. |
| [Meetings](meetings) | How to manage meetings to create and share meeting agenda and meeting minutes. |
| [News](news) | How to create and manage News for your projects. |
| [Using the Nextcloud integration](nextcloud-integration) | How to link and use Nextcloud files and folders in OpenProject |
Expand Down
7 changes: 4 additions & 3 deletions docs/user-guide/agile-boards/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Boards support agile project management methodologies, such as Scrum or Kanban.

Our Agile boards can be for anything you would like to keep track of within your projects: Tasks to be done, Bugs to be fixed, Things to be reviewed, Features to be developed, Risks to be monitored, Ideas to be spread, anything! The boards consist of lists (columns) and cards. You can choose between a Basic board and various advanced Action boards.

> **Note**: The basic board is included in the OpenProject Community Edition. OpenProject Action boards is a Premium Feature and can only be used with [Enterprise cloud](../../enterprise-guide/enterprise-cloud-guide/) or [Enterprise on-premises](../../enterprise-guide/enterprise-on-premises-guide/). An upgrade from the free Community Edition is easily possible.
> **Note**: The basic board is included in the OpenProject Community Edition. OpenProject Action boards are a Premium Feature and can only be used with [Enterprise cloud](../../enterprise-guide/enterprise-cloud-guide/) or [Enterprise on-premises](../../enterprise-guide/enterprise-on-premises-guide/). An upgrade from the free Community Edition is easily possible.


| Topic | Content |
Expand All @@ -29,6 +29,7 @@ Our Agile boards can be for anything you would like to keep track of within your
| [Examples for agile boards](#agile-boards-examples) | Best practices for using the basic board and status, assignee and version board. |

<video src="https://openproject-docs.s3.eu-central-1.amazonaws.com/videos/OpenProject-Agile-Boards.mp4" type="video/mp4" controls="" style="width:100%"></video>

## Agile boards in OpenProject

The new Boards are tightly integrated with all other project management functionalities in OpenProject, i.e. work packages or Gantt charts. This makes it so easy and practical to include the Boards in your daily project management routines and to gain a much quicker overview of important topics in your project.
Expand All @@ -49,12 +50,12 @@ Click on the green **+Board** button to create a new Board view.

Next, you need to choose which kind of Agile board you want to create.

### Basic board (Community Edition)
## Basic board (Community edition)
The Basic board is included in the OpenProject Community Edition. You can freely create lists, name them and order your work packages within. If you move work packages between the lists, there will be **NO changes** to the work package itself. This allows you to create flexible boards for any kind of activity you would like to track, e.g. Management of Ideas.

![Board types basic board](Board-types-basic-board.png)

### Action boards (Premium feature)
## Action boards (Premium feature)

In an Action board each lists represents a value of an attribute of the contained work packages (cards), e.g. there's a list for the status "New" and a list for the status "In Progress" in the Status board.
Moving work packages (cards) between two lists will update them automatically, based on the list to which they're moved.
Expand Down
3 changes: 2 additions & 1 deletion docs/user-guide/team-planner/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ keywords: team planner,planning calendar, resource management
---

# Team planner

The team planner is a module that can assist getting a better overview of which team member is working on what work package at what time. It is also a useful tool to schedule those team members for different tasks on various times.

> **Note**: The team planner is a premium feature and only included in the [Enterprise cloud](../../enterprise-guide/enterprise-cloud-guide/) or [Enterprise on-premises](../../enterprise-guide/enterprise-on-premises-guide/). An upgrade from the free Community edition is easily possible.

A few notes:

1. The work package module has to be enabled as a prerequisite for the team planner
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/wysiwyg/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ The following list contains all supported attribute names for the `workPackageVa

| **Attribute** | Usage example |
| ------------------- | ------------------------------------------------------------ |
| Custom Fields | `workPackageValue:1234:"Name of the work package custom field"` |
| *Custom Fields* | `workPackageValue:1234:"Name of the work package custom field"` |
| Assignee | `workPackageValue:1234:assignee` |
| Author | `workPackageValue:1234:author` |
| Category | `workPackageValue:1234:category` |
Expand Down