@recaptime-dev's working patches + fork for Phorge, a community fork of Phabricator. (Upstream dev and stable branches are at upstream/main and upstream/stable respectively.)
hq.recaptime.dev/wiki/Phorge
phorge
phabricator
Write documentation for profile menus
Summary: Ref T10054. This is all pretty straightforward. Also include some project-specific examples in the project documentation.
Test Plan: Read documentation.
Reviewers: chad
Reviewed By: chad
Maniphest Tasks: T10054
Differential Revision: https://secure.phabricator.com/D15090
+191
-14
-12
src/applications/project/engine/PhabricatorProjectProfilePanelEngine.php
-12
src/applications/project/engine/PhabricatorProjectProfilePanelEngine.php
···
20
20
->setBuiltinKey(PhabricatorProject::PANEL_WORKBOARD)
21
21
->setPanelKey(PhabricatorProjectWorkboardProfilePanel::PANELKEY);
22
22
23
-
// TODO: This is temporary.
24
-
$uri = urisprintf(
25
-
'/maniphest/?statuses=open()&projects=%s#R',
26
-
$object->getPHID());
27
-
28
-
$panels[] = $this->newPanel()
29
-
->setBuiltinKey('tasks')
30
-
->setPanelKey(PhabricatorLinkProfilePanel::PANELKEY)
31
-
->setPanelProperty('icon', 'maniphest')
32
-
->setPanelProperty('name', pht('Open Tasks'))
33
-
->setPanelProperty('uri', $uri);
34
-
35
23
$panels[] = $this->newPanel()
36
24
->setBuiltinKey(PhabricatorProject::PANEL_MEMBERS)
37
25
->setPanelKey(PhabricatorProjectMembersProfilePanel::PANELKEY);
+6
-2
src/applications/search/engine/PhabricatorProfilePanelEngine.php
+6
-2
src/applications/search/engine/PhabricatorProfilePanelEngine.php
···
630
630
631
631
if ($panel->isDisabled()) {
632
632
$hide_icon = 'fa-plus';
633
-
$hide_text = pht('Show');
633
+
$hide_text = pht('Enable');
634
634
} else if ($panel->getBuiltinKey() !== null) {
635
635
$hide_icon = 'fa-times';
636
636
$hide_text = pht('Disable');
···
683
683
->setLabel(true)
684
684
->setName(pht('Documentation')));
685
685
686
+
$doc_link = PhabricatorEnv::getDoclink('Profile Menu User Guide');
687
+
$doc_name = pht('Profile Menu User Guide');
688
+
686
689
$action_view->addAction(
687
690
id(new PhabricatorActionView())
688
691
->setIcon('fa-book')
689
-
->setName(pht('TODO: Write Documentation')));
692
+
->setHref($doc_link)
693
+
->setName($doc_name));
690
694
691
695
$action_button = id(new PHUIButtonView())
692
696
->setTag('a')
+42
src/docs/user/userguide/projects.diviner
+42
src/docs/user/userguide/projects.diviner
···
51
51
52
52
If you'd like to receive edit notifications for a project, you can write a
53
53
Herald rule to keep you in the loop.
54
+
55
+
56
+
Customizing Menus
57
+
=================
58
+
59
+
Projects support profile menus, which are customizable. For full details on
60
+
managing and customizing profile menus, see @{article:Profile Menu User Guide}.
61
+
62
+
Here are some examples of common ways to customize project profile menus that
63
+
may be useful:
64
+
65
+
**Link to Tasks or Repositories**: You can add a menu item for "Open Tasks" or
66
+
"Active Repositories" for a project by running the search in the appropriate
67
+
application, then adding a link to the search results to the menu.
68
+
69
+
This can let you quickly jump from a project screen to related tasks,
70
+
revisions, repositories, or other objects.
71
+
72
+
For more details on how to use search and manage queries, see
73
+
@{article:Search User Guide}.
74
+
75
+
**New Task Button**: To let users easily make a new task that is tagged with
76
+
the current project, add a link to the "New Task" form with the project
77
+
prefilled, or to a custom form with appropriate defaults.
78
+
79
+
For information on customizing and prefilling forms, see
80
+
@{article:User Guide: Customizing Forms}.
81
+
82
+
**Link to Wiki Pages**: You can add links to relevant wiki pages or other
83
+
documentation to the menu to make it easy to find and access. You could also
84
+
link to a Conpherence if you have a chatroom for a project.
85
+
86
+
**Link to External Resources**: You can link to external resources outside
87
+
of Phabricator if you have other pages which are relevant to a project.
88
+
89
+
**Set Workboard as Default**: For projects that are mostly used to organize
90
+
tasks, change the default item to the workboard instead of the profile to get
91
+
to the workboard view more easily.
92
+
93
+
**Hide Unused Items**: If you have a project which you don't expect to have
94
+
members or won't have a workboard, you can hide these items to streamline the
95
+
menu.