Panels list: fix missing welcome page
ClosedPublic
Actions

Authored by valerio.bozzolan on May 31 2024, 12:24.

Details

Reviewers

aklapper

Group Reviewers

O1: Blessed Committers

Maniphest Tasks

T15844: Dashboard Panel list: missing welcome page

Commits

rP89dcbe125c6c: Panels list: fix missing welcome page

Summary

The method getNewUserBody() was never designed for a list controller.
The method was just orphan. Now, instead, it's non-orphan, and it works
as expected.

This bug was highlighted by Andre Klapper, since their linter was screaming
about inconsistences in the current nonsense usage of getNewUserBody():

D25649

The code was just moved from the list controller, to the search engine.

PhabricatorDashboardPanelListController (from)
PhabricatorDashboardPanelSearchEngine (to)

Bonus point:

Adjusted the icon and the title to talk about "Panels" and not "Dashboards".

Added also some inline documentation with an hint about ?nux=1.
So now we can easily remember how to test this kind of things.

Closes T15844

Test Plan

In both these pages, you finally see a welcome message, not just in Maniphest:

In both these pages, if you have no elements, you finally see a welcome message,
and not just in Maniphest:

Check that the welcome message helps you in creating a new Panel, and that
talks about Panels, and that have the lovely icon of a Panel.

Diff Detail

Repository

rP Phorge

Branch

master

Lint

Lint Passed

Unit

Tests Passed

Build Status

Buildable 1309
Build 1309: arc lint + arc unit

Event Timeline

valerio.bozzolan created this revision.May 31 2024, 12:24

Owners added a reviewer: O1: Blessed Committers.May 31 2024, 12:24

Herald added subscribers: Cigaryno, Matthew, tobiaswiese. · View Herald TranscriptMay 31 2024, 12:24

valerio.bozzolan requested review of this revision.May 31 2024, 12:24

Harbormaster completed remote builds in B1309: Diff 2056.May 31 2024, 12:24

aklapper mentioned this in D25649: Fix call to non-existing getApplication() in PhabricatorDashboardPanelListController.May 31 2024, 13:14

I confirm that all other 21 definitions of function getNewUserBody() are in *Engine.php files/classes, except the one fixed/moved by this very patch.

I can also confirm that http://phorge.localhost/dashboard/panel/?nux=1 displays a nice Welcome to Panels box instead of the line No panels found. when using ?nux=1 after applying this patch, just like other applications do in this case.

Thus this approach looks correct to me.

This revision is now accepted and ready to land.Jun 3 2024, 17:21

Closed by commit rP89dcbe125c6c: Panels list: fix missing welcome page. · Explain WhyJun 3 2024, 23:45

This revision was automatically updated to reflect the committed changes.

valerio.bozzolan added a commit: rP89dcbe125c6c: Panels list: fix missing welcome page.