burningmantech / ranger-clubhouse-web

Ranger Secret Clubhouse Web Application
Apache License 2.0
13 stars 10 forks source link

Positions admin page should designate relevant teams for trainer's report #1471

Closed srabraham closed 1 year ago

srabraham commented 1 year ago

The trainer's report lists teams for each Ranger (see screenshot). Currently we do client-side combining and filtering of positions to get to the values that are actually shown in the UI, via this TITLE_MAP. This means that updates to what gets shown need to be done by members of the tech team, e.g. this request via an Issue https://github.com/burningmantech/ranger-clubhouse-web/issues/1255.

@mikeburg points out that we should instead achieve all this via a new column on the positions table, something like "show on trainer report", which would be fed through the API and lead us to not need that TITLE_MAP. The value of that column would be set from the positions admin page.

image

srabraham commented 1 year ago

This is Mike's idea, and I'm just relaying it here from a call we had. The one thing I'm not so clear about is what values are actually desirable in that "teams" column in the trainer's report. We could just list the position short titles instead of "teams", though not all positions even have short titles, and this might lead to much longer values in that column. This is just to say that the TITLE_MAP is doing some additional work for us, not just filtering things out, but also grouping positions into simple representations ("GD" for all green dot positions, etc.)

mikeburg commented 1 year ago

The Clubhouse Teams work is coming down the pike and will have an impact here. The project's goal is to formally add team representation into the website by flagging various positions as a 'team' and to organize the existing positions underneath the teams. Some existing positions will be flagged as a team (e.g., '007', 'Volunteer Cords', etc.) and new ones will be created. (e.g., 'Council', 'Green Dot Team', etc).

Until that's deployed, let's go forward with using short titles, and adding a column to the position table to flag the position to be included on the report. When the teams work is deployed, and things have stabilized (both in terms of code and position origination) , we can revisit the report to see if the teams' short titles (e.g., the team "Green Dot Team" with the short code "GD") can be used as-is without any short title remapping.

The short titles are used in multiple reports, the main one being the Shift Lead Report (SLR). The ideal situation is consistency across all the interfaces. And if the SLR and the trainer's report can use the same abbreviations, awesome!

For the position legend at the bottom, use the full position title to describe the short title. Also have each position on its own line. The legend section should also start on a new page when printed. The d-print-page-break CSS selector will cause a page break.

New trainers may not be familiar with the short titles/descriptions, and veteran trainers may forget what's what.

mikeburg commented 1 year ago

Thank you @srabraham -- closing this out.