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

Feature/57778 remove the project details widget from project overview #17042

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
1 change: 0 additions & 1 deletion config/locales/js-en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -777,7 +777,6 @@ en:
required_outside_context: >
Please choose a project to create the work package in to see all attributes.
You can only select projects which have the type above activated.
details_activity: "Project details activity"
context: "Project context"
click_to_switch_to_project: "Project: %{projectname}"
confirm_template_load: "Switching the template will reload the page and you will lose all input to this form. Continue?"
Expand Down
13 changes: 13 additions & 0 deletions db/migrate/20241025072902_remove_project_details_widget.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
class RemoveProjectDetailsWidget < ActiveRecord::Migration[7.1]
def up
# The joining of the overview grids is not strictly necessary
# but it ensures that only widgets of overview grids are removed.
execute <<~SQL.squish
DELETE FROM grid_widgets
USING grids
WHERE grids.id = grid_widgets.grid_id
AND grids.type = 'Grids::Overview'
AND grid_widgets.identifier = 'project_details'
SQL
end
end
3 changes: 0 additions & 3 deletions docs/development/concepts/inline-editing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,12 +226,9 @@ An example where this comes into play is the [`CustomText`](https://github.com/o
- [`EditFieldComponent`](https://github.com/opf/openproject/tree/dev/frontend/src/app/shared/components/fields/edit/field-types) definitions containing all display fields and the service to instantiate them
- [`EditingPortalService`](https://github.com/opf/openproject/tree/dev/frontend/src/app/shared/components/fields/edit/editing-portal/editing-portal-service.ts) service to create an edit field with event handling in code
- [`WorkPackageFullViewComponent`](https://github.com/opf/openproject/blob/dev/frontend/src/app/features/work-packages/routing/wp-full-view/wp-full-view.html) Work package full view template that uses the `edit-form` attribute to create a form for the work package full view (as seen in the Gif above)
- [`ProjectDetailsComponent`](https://github.com/opf/openproject/blob/dev/frontend/src/app/shared/components/grids/widgets/project-details/project-details.component.html) Exemplary widget template that uses the form for project attributes

## Minimal example

The [`ProjectDetailsComponent`](https://github.com/opf/openproject/blob/dev/frontend/src/app/shared/components/grids/widgets/project-details/project-details.component.html) is a very isolated example showing how to use the edit-form together with `EditableAttributeField` component to show the actual inline-editable field.

On the example of a work package, this following code snippet would create an edit form for a given work package resource and an attribute for the `subject` attribute of that work package.

```html
Expand Down
2 changes: 1 addition & 1 deletion docs/system-admin-guide/attribute-help-texts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The Attribute help texts for work packages will be displayed in the [details vie

## Projects

The Attribute help texts for projects will be displayed in the Project details widget in the [Project overview](../../user-guide/project-overview/) (as in the first screenshot below) and in the [Project settings](../../user-guide/projects/project-settings/project-information/) (as in the second screenshot below).
The Attribute help texts for projects will be displayed in the [Project overview](../../user-guide/project-overview/) (as in the first screenshot below) and in the [Project settings](../../user-guide/projects/project-settings/project-information/) (as in the second screenshot below).

They will help the users (e.g. the project managers) understand what kind of information to put in which fields.

Expand Down
13 changes: 0 additions & 13 deletions docs/user-guide/project-overview/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,19 +143,6 @@ The description can be added or changed in the [project settings](../projects/pr

![project description widget](image-20191112143652698.png)

### Project details widget

> [!IMPORTANT]
> Project details widget was replaced by [Project attributes](#project-attributes) in [OpenProject 14.0](../../release-notes/14-0-0/) and will be removed in the future.

The project details widget displays all custom fields for projects, e.g. project owner, project due date, project number, or any other custom field for this project.

The custom fields can be adapted in the [project settings](../projects/project-settings/). As a system administrator you can [create new custom fields for projects](../../system-admin-guide/custom-fields/custom-fields-projects/).

![project details widget](image-20191112144557906.png)

New custom fields for projects can be created in the [system administration](../../system-admin-guide/).

### Project status widget

Add your project status as a widget to display at a glance whether your project is on track, off track or at risk.
Expand Down
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,6 @@ import { WidgetHeaderComponent } from 'core-app/shared/components/grids/widgets/
import { WidgetWpOverviewComponent } from 'core-app/shared/components/grids/widgets/wp-overview/wp-overview.component';
import { WidgetCustomTextComponent } from 'core-app/shared/components/grids/widgets/custom-text/custom-text.component';
import { OpenprojectFieldsModule } from 'core-app/shared/components/fields/openproject-fields.module';
import {
WidgetProjectDetailsComponent,
} from 'core-app/shared/components/grids/widgets/project-details/project-details.component';
import {
WidgetProjectDetailsMenuComponent,
} from 'core-app/shared/components/grids/widgets/project-details/project-details-menu.component';
import {
WidgetTimeEntriesProjectComponent,
} from 'core-app/shared/components/grids/widgets/time-entries/project/time-entries-project.component';
Expand All @@ -89,7 +83,7 @@ import {
} from './widgets/time-entries/current-user/configuration-modal/configuration.modal';
import {
WidgetProjectFavoritesComponent,
} from "core-app/shared/components/grids/widgets/project-favorites/widget-project-favorites.component";
} from 'core-app/shared/components/grids/widgets/project-favorites/widget-project-favorites.component';
import { IconModule } from 'core-app/shared/components/icon/icon.module';

@NgModule({
Expand Down Expand Up @@ -130,15 +124,13 @@ import { IconModule } from 'core-app/shared/components/icon/icon.module';
WidgetWpTableQuerySpaceComponent,
WidgetWpGraphComponent,
WidgetProjectDescriptionComponent,
WidgetProjectDetailsComponent,
WidgetProjectStatusComponent,
WidgetSubprojectsComponent,
WidgetProjectFavoritesComponent,
WidgetTimeEntriesCurrentUserComponent,
WidgetTimeEntriesProjectComponent,

// Widget menus
WidgetProjectDetailsMenuComponent,
WidgetMenuComponent,
WidgetWpTableMenuComponent,
WidgetWpGraphMenuComponent,
Expand Down Expand Up @@ -331,14 +323,6 @@ export function registerWidgets(injector:Injector) {
},
},
},
{
identifier: 'project_details',
component: WidgetProjectDetailsComponent,
title: i18n.t('js.grid.widgets.project_details.title'),
properties: {
name: i18n.t('js.grid.widgets.project_details.title'),
},
},
{
identifier: 'project_status',
component: WidgetProjectStatusComponent,
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

Loading
Loading