Paths

Table of Contentst

Differential D25675

Drydock and Almanac: add welcome pages
ClosedPublic
Actions

Authored by valerio.bozzolan on May 31 2024, 16:10.

Details

Reviewers

aklapper

Group Reviewers

O1: Blessed Committers

Maniphest Tasks

T15018: Make Harbormaster more generally usable and extendable

Commits

rP68762e820417: Drydock and Almanac: add welcome pages

Summary

Premising that I still consider Almanac, Drydock and Harbormaster as dark magic, and premising that all my knowledge about these components is here:

https://en.wikibooks.org/wiki/Phabricator_Administrator%27s_Handbook/Continuous_integration

(Above guide linked from Community Resources)

Hoping to be useful, I've added some welcome pages, precious to newcomers, with the goal to lower a bit the learning barrier to these tricky components.

Drydock Blueprints

Screenshot of the new welcome page in Drydock → Blueprints:

Since Drydock Blueprints are deeply dependent to Almanac, we added an extra blue button to see its homepage.

So, you are then 2-clicks away from...

Almanac Services

Screenshot of the new welcome page in Almanac → Services:

Since Almanac Services are deeply dependent to Almanac → Devices, we added an extra blue button to see them.

So, you are then 1-click away from...

Almanac Devices

Screenshot of the new welcome page in Almanac → Devices:

Since Almanac Devices are deeply dependent to Almanac → Networks, we added an extra blue button to see them.

So, you are then 1-click away from...

Almanac Networks

Screenshot of the new welcome page in Almanac Networks:

And, that's it.

Notes

Ref T15018

After this change, at least 1 newcomer will love Phorge at the maximum level. and they will never again be able to use the proprietary GitHub.

bwahaha

Test Plan

Visit all the following pages, forcing the welcome "new user interface" mode:

http://phorge.localhost/drydock/blueprint/?nux=1

http://phorge.localhost/almanac/service/?nux=1

http://phorge.localhost/almanac/device/?nux=1

http://phorge.localhost/almanac/network/?nux=1

Test all action buttons.

Write a comment with "yesyes" or "bwahaha" or "chadyes" in production too.

Diff Detail

Repository

rP Phorge

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

valerio.bozzolan created this revision.May 31 2024, 16:10

Owners added a reviewer: O1: Blessed Committers.May 31 2024, 16:10

Herald added subscribers: Cigaryno, Matthew, tobiaswiese. · View Herald TranscriptMay 31 2024, 16:10

valerio.bozzolan requested review of this revision.May 31 2024, 16:10

Harbormaster completed remote builds in B1310: Diff 2057.May 31 2024, 16:10

valerio.bozzolan edited the summary of this revision. (Show Details)May 31 2024, 16:12

aklapper subscribed.May 31 2024, 16:37

aklapper added inline comments.

src/applications/almanac/query/AlmanacDeviceSearchEngine.php
159	This comma should be removed. Maybe also singular "network"?
src/applications/almanac/query/AlmanacServiceSearchEngine.php
139	This comma should be removed. Or maybe "based on your devices"?

I'd also prefer American English spelling for the sake of consistency, means: using catalog instead of catalogue.
cf https://we.phorge.it/source/arcanist/browse/master/src/workflow/ArcanistWorkflow.php$840 :P

Apart from that it took me a moment to understand that the "blue" buttons in the box intentionally link to a different aspect of the applications to allow lookup (as that box is by default only shown anyway when no objects have been set up yet).

Could make sense to also introduce this for http://phorge.localhost/almanac/namespace/?nux=1 but that would be sugar on top.

All in all, this looks ready to merge after removing two commas and fixing one BE spelling. I tested this locally and everything worked as expected.

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

valerio.bozzolan added inline comments.Jun 3 2024, 23:43

src/applications/almanac/query/AlmanacDeviceSearchEngine.php
159	comma: yup thanks Maybe keeping 'networks' in plural since the button is See Networks that shows the Networks list
src/applications/almanac/query/AlmanacServiceSearchEngine.php
139	Thanks. Thinking about the word "service providers". Do you like also ", provided by your devices"?

AlmanacDeviceSearchEngine: add comma, but maybe keeping 'networks' in plural since the button is See Networks
AlmanacServiceSearchEngine: -of your devices +provided by your devices

Harbormaster completed remote builds in B1315: Diff 2064.Jun 3 2024, 23:43

Tried to re-phrase a bit, thanks to feedback from Italian coworkers and Andrè. lol

Harbormaster completed remote builds in B1332: Diff 2092.Jun 7 2024, 12:18

I will update the screenshots. Let's wait another +1 on strings.

valerio.bozzolan edited the summary of this revision. (Show Details)Jun 25 2024, 07:39

Closed by commit rP68762e820417: Drydock and Almanac: add welcome pages. · Explain WhyJun 25 2024, 07:40

This revision was automatically updated to reflect the committed changes.

valerio.bozzolan added a commit: rP68762e820417: Drydock and Almanac: add welcome pages.

valerio.bozzolan mentioned this in Next Up.Jun 25 2024, 07:54

valerio.bozzolan mentioned this in 2024 week 35.Aug 28 2024, 10:19