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.

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

adding internal links to blog articles into docs #16928

Merged
merged 4 commits into from
Oct 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Watch the following video to see how you can configure your custom actions:

Navigate to the -> *Administration* -> *Work packages* -> *Custom actions*.

To create a new custom action button press the green **+ Custom action** button.
To create a new custom action button press the + Custom action** button.

![custom actions overview in OpenProject administration](openproject_system_guide_work_packages_custom_actions_overview.png)

Expand All @@ -51,3 +51,7 @@ If a work package is then in the defined condition, the button will appear on to
3. Delete a custom action.

![Update or delete custom actions in OpenProject administration](openproject_system_guide_work_packages_custom_actions_edit_delete.png)

> [!TIP]
>
> Read this [blog article](https://www.openproject.org/blog/custom-action-self-assign/) for an example of custom actions used within OpenProject team to quickly self-assign a work package.
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,6 @@ You can get a summary of the allowed status transitions of a work package type f
You will then view a summary of all the workflows. The number of possible status transitions for each type and role are shown in a matrix.

![Overview of work package workflow summary in OpenProject administration](System-admin-guide-work-package-workflows_overview.png)

> [!TIP]
> For more examples on using workflows in OpenProject take a look at [this blog article](https://www.openproject.org/blog/status-and-workflows/).
3 changes: 3 additions & 0 deletions docs/user-guide/meetings/dynamic-meetings/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ The menu on the left will allow you to filter for upcoming or past meetings. You

![Meetings overview in openproject global modules](openproject_userguide_dynamic_meetings_overview.png)

> [!TIP]
> If you are interested in how the Meetings module is used by the OpenProject team, please take a look at [this blog article](https://www.openproject.org/blog/meeting-management-example/).

## Create and edit dynamic meetings

### Create a new meeting
Expand Down
6 changes: 5 additions & 1 deletion docs/user-guide/wiki/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ The attachment will be automatically uploaded and stored as an attachment.

## Macros

OpenProject has supported macros on textile formatted pages and continues to do so with the WYSIWYG editor. Note that macros are not expanded while editing the page, instead a placeholder is shown.
OpenProject has supported macros on textile formatted pages and continues to do so with the [WYSIWYG](../wysiwyg) editor. Note that macros are not expanded while editing the page, instead a placeholder is shown.

### Table of contents

Expand All @@ -110,6 +110,10 @@ Configure a button or link to target the work package creation screen in the cur

Create a hierarchical list of all child pages of the current page.

> [!TIP]
>
> For more information on using macros take a look at this [blog article](https://www.openproject.org/blog/how-to-use-macros/).

## Full vs constrained editor

In some resources such as work packages or comments, the editor does not exhibit all functionality such as macros or image upload.
Expand Down
36 changes: 26 additions & 10 deletions docs/user-guide/work-packages/baseline-comparison/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ keywords: baseline comparison, work package changes

Baseline is a powerful feature that allows you to view changes to work package tables within a given period. This can be a saved view or a new filter query. Project managers can use baseline to get a quick overview of what has changed over time, making it easier to report on project progress and status.

>**Note:** Baseline comparison with yesterday is included in the Community version. Other comparison dates are Enterprise add-ons that are available with Enterprise cloud or Enterprise on-premises. An upgrade from the free Community edition is easily possible.
> [!NOTE]
> Baseline comparison with yesterday is included in the Community version. Other comparison dates are Enterprise add-ons that are available with Enterprise cloud or Enterprise on-premises. An upgrade from the free Community edition is easily possible.

![Work package table list with Baseline enabled](13-0_Baseline_overview.png)

Expand Down Expand Up @@ -48,23 +49,28 @@ Baseline offers these preset time ranges:

By default, Baseline will compare to 8 AM local time of the relevant day. You can change this to any other time of your choosing.

>**Note:** These are relative comparison points, which means that _Yesterday_ will always refer to the day before the current day, and not a specific date. You can use these to set up "running" baselines that show you all changes within the past day or week.
>[!NOTE]
>These are relative comparison points, which means that _Yesterday_ will always refer to the day before the current day, and not a specific date. You can use these to set up "running" baselines that show you all changes within the past day or week.

### A specific date

![You can compare the present state to a specific date in the past](13-0_Baseline_specificDate.png)

If you want to compare between now and a specific date in the past, you can select "a specific date" in the dropdown and select a particular date. With this option, the comparison will always be between the current state and that specific date in the past.

>**Note:** You can use this to "freeze" the baseline comparison point so that the view always shows changes in comparison to that specific date, regardless of when you access it.
>[!NOTE]
>
>You can use this to "freeze" the baseline comparison point so that the view always shows changes in comparison to that specific date, regardless of when you access it.

### Between two specific dates

![You can see changes between two dates](13-0_Baseline_dateRange.png)

OpenProject also allows you to compare between two specific dates in the past. To select a custom date range, choose "between two specific dates" in the dropdown and select two dates in the date picker below.

>**Note**: This will create a fixed baseline view that will remain the same regardless of when you accesses it, since both points are fixed in the past.
>[!NOTE]
>
>This will create a fixed baseline view that will remain the same regardless of when you accesses it, since both points are fixed in the past.

## Understanding the comparison results

Expand All @@ -89,15 +95,19 @@ When Baseline is enabled, you will see a legend at the top of the page which sho

Work packages that meet the filter criteria now but did not in the past are marked with an "Added" icon. These work packages were added to the current query after the selected comparison point, either because they were newly created since then or certain attributes changed such that they meet the filter criteria.

> **Note**: These do not necessarily represent _newly created_ work packages; simply those that are new to this particular view because they now meet the filter criteria.
> [!NOTE]
>
> These do not necessarily represent _newly created_ work packages; simply those that are new to this particular view because they now meet the filter criteria.

#### No longer meets filter criteria

![Icon](13-0_Baseline_noLongerMeets.png)

Work packages that no longer meet the filter criteria now are marked with a "Removed" icon. These work packages were filtered out within the comparison period.

>**Note**: These do _not_ represent deleted work packages, which are not visible at all since no history of deleted work packages is maintained. Deleted work packages are simply ignored by Baseline.
>[!NOTE]
>
>These do _not_ represent deleted work packages, which are not visible at all since no history of deleted work packages is maintained. Deleted work packages are simply ignored by Baseline.

#### Maintained with changes

Expand All @@ -119,16 +129,22 @@ Each attribute that has changed will have a grey background, with the old value

This allows you to have a complete view of what has changed in the comparison period.

>**Note**: Some attributes like _Spent time_ and _Progress_ are not tracked by Baseline and do not show the old values in the work package table. If any of the columns in your work package table are not tracked, a small warning icon in the column header will indicate this.
>[!NOTE]
>
> ![Unsupported columns have a warning icon next to them](13_0_Baseline_unsupportedColumn.png)
>Some attributes like _Spent time_ and _Progress_ are not tracked by Baseline and do not show the old values in the work package table. If any of the columns in your work package table are not tracked, a small warning icon in the column header will indicate this.
>
>![Unsupported columns have a warning icon next to them](13_0_Baseline_unsupportedColumn.png)

## Relation to active filters

Baseline always compares work packages between the two comparison points in relation to the current active filters. Changing the filters can change the results of the comparison.

It is not possible to compare between two different filter queries.

>**Note**: Some filter attributes are not tracked by Baseline and changes to them will not be taken into consideration. These include _Watcher_, _Attachment content_, _Attachment file name_ and _Comment_. These attributes are marked with a small warning icon next to them in the filter panel.
>[!NOTE]
>
>Some filter attributes are not tracked by Baseline and changes to them will not be taken into consideration. These include _Watcher_, _Attachment content_, _Attachment file name_ and _Comment_. These attributes are marked with a small warning icon next to them in the filter panel.
>
> ![An icon and a message warning that certain filter criteria are not taken into account by Baseline](13-0_Baseline_activeFilters.png)
>![An icon and a message warning that certain filter criteria are not taken into account by Baseline](13-0_Baseline_activeFilters.png)

If you are interested in Baseline, please also take a look at this [blog article](https://www.openproject.org/blog/view-changes-on-project-baseline/).
4 changes: 4 additions & 0 deletions docs/user-guide/wysiwyg/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,10 @@ To avoid processing these items, preceding them with a bang `!` character such a
> [!NOTE]
> All these macros need to be written as a new word (i.e., with at least one space before it or at the beginning of a paragraph/sentence). Macros contained within a word such as `somethingmeeting#4` will not be parsed.

> [!TIP]
>
> For more information on using macros, take a look at this [blog article](https://www.openproject.org/blog/how-to-use-macros/).

### Autocompletion for work packages and users

For work packages and users, typing `#` or `@` will open an autocomplete dropdown for visible work packages and users, respectively.
Expand Down