Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide help text for use of Info field #40

Open
ldang opened this issue Mar 18, 2024 · 0 comments
Open

Provide help text for use of Info field #40

ldang opened this issue Mar 18, 2024 · 0 comments

Comments

@ldang
Copy link
Collaborator

ldang commented Mar 18, 2024

The Info field makes it easy for us to annotate the room streams, based on the preference.

Additionally, it would be nice to have a collapsible help where we can provide guidance of how to use the Info field and a flagging convention to make it easier to communicate complex states concisely, aka keep things on a single line.

Currently, it's a bit haphazard

Example: showing state of room stream cutting
scale20x_info_help_example

Example: showing room topics and some annotation
scale21x_topics

So we have to define what it is we want to encode about each room stream, maybe come up with a set of symbols or progression that would let us know:

  • room topic
  • any technical issues with room stream - provides great training example for monitoring, remind us of A/V issues for post-mortem, point out technical issue with info in signs.xml and the schedule
  • reasons we can't publish room stream - mostly workshops are unusable or not recorded
  • has it been cut
  • has it been published
  • has room stream been unlisted, which means it has been completely dealt with

Once we come up with an encoding, we will probably need a legend or collapsible help, so we can consistently encode it correctly and others can understand the code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant