educates / educates-training-platform

A platform for hosting interactive workshop environments in Kubernetes, or on top of a local container runtime.
https://educates.dev
Apache License 2.0
76 stars 21 forks source link

rename `Open Workshop` to `Open Instructions` in the top right hamburger menu #223

Open djschny opened 1 year ago

djschny commented 1 year ago

Is your feature request related to a problem? Please describe.

The word workshop is ambiguous to the average learner that would use educates (or even know they are using it). The word Terminal in that list is obvious, but using Instructions instead of Workshop I believe is much more universal in the context of educational content.

Describe the solution you'd like

Rename Open Workshop to Open Instructions

Describe alternatives you've considered

Additional information

No response

GrahamDumpleton commented 1 year ago

If making a change like this, I would suggest coming up with a way to provide a configuration table to allow localisation of such text. This would allow someone to change such labels to Spanish or Japanese if that is what the workshop content was in. The same could be used to change just the English version of text if desired as the whole dashboard could be used for things other than workshops with instructions so someone may want to change it to something entirely different. There should also perhaps in this configuration be away to disable selectively some menu options, or even add more if people wanted to use it to provide links off to other stuff.

djschny commented 1 year ago

Sure that would be nice. However for as simple as the change is, I would suggest getting value with the initial change and a separate change/issue for the more sophisticated logic you mention.

GrahamDumpleton commented 1 year ago

As a quick solution to this, add a Javascript file as part of a theme (global or training portal specific) which contains code to select the menu item value and override it. For example, if you were using a global theme defined in the data values file, you would use:

websiteStyling:
  workshopDashboard:
    script:  |
      document.querySelector('li#workarea-controls a[data-url="/workshop/"]').innerHTML = "Open Instructions"

This should yield the result as shown.

image

If using secrets for distinct themes, then add the code to the workshop-dashboard.js value within the secret.

For details on theme configuration see:

djschny commented 1 year ago

It's a one-line change. I submitted the PR and referenced this issue.

The styling option seems silly for something like this. Not sure what I'm missing.

GrahamDumpleton commented 1 year ago

Related to this issue is existing issue https://github.com/vmware-tanzu-labs/educates-training-platform/issues/193 where was asked for pop out icon to be included in top bar of rendered instructions. Was suggested at the time that menu item be removed if this was added. If using custom instructions renderer, would be up to provider of that to provide their own pop out icon.

djschny commented 1 year ago

Correct, I saw that, however that didn't talk about removing it from the existing menu. So I was assuming the right Open Workshop was going to stay and therefore having this renamed would help there. If #193 should be updated to say that it's removed from the existing menu item, then this is request is not applicable.