Page MenuHomePhorge

Drydock and Almanac: add welcome pages
ClosedPublic

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

Details

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 DrydockBlueprints:

Phorge Drydock Blueprints welcome.jpg (315×660 px, 29 KB)

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 AlmanacServices:

Phorge Almanac Services welcome.png (294×660 px, 20 KB)

Since Almanac Services are deeply dependent to AlmanacDevices, 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 AlmanacDevices:

Phorge Almanac Devices welcome.png (294×660 px, 20 KB)

Since Almanac Devices are deeply dependent to AlmanacNetworks, 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:

Phorge Almanac Networks welcome.png (294×660 px, 19 KB)

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
Branch
master
Lint
Lint Passed
Unit
Tests Passed
Build Status
Buildable 1310
Build 1310: arc lint + arc unit

Event Timeline

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
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

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

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