feat: added version information in the interface and outputs - Githubissues

ReadAlongs / Studio-Web

Suite of web packages for creating interactive ReadAlongs (this repo was formerly called Web-Component)

https://readalong-studio.mothertongues.org/

Other

9 stars 9 forks source link

feat: added version information in the interface and outputs #304

Closed deltork closed 3 months ago

deltork commented 3 months ago

PR Goal?

Make version information visible to users and visible in output formats.

Version information will be used for techincal support inquires and allow data import processing

In this PR the version information was added to :

web-component (in settings dialog).
studio interface (bottom of the page)
output html meta and read-along tags of single page and web bundle formats

Fixes?

Fixes #300, #268

Feedback sought?

How easy is it find the version information? Is it too intrusive? see issue #268 & #300

Priority?

low

Tests added?

yes

How to test?

Confidence?

high

Version change?

minor

github-actions[bot] commented 3 months ago

PR Preview Action v1.4.7 :---: Preview removed because the pull request was closed. 2024-06-03 15:48 UTC

joanise commented 3 months ago

I'm not sure this is related to #300, was that just a mis-tag?

joanise commented 3 months ago

I'm not sure this is related to #300, was that just a mis-tag?

Or maybe it's also in this PR, along with the version info changes?

joanise commented 3 months ago

This looks good to me. Minor optional change: instead of just Version: 1.4.0 for the studio-web, maybe @reeadalongs/studio-web version: 1.4.0?

joanise commented 3 months ago

If I start fresh and try to run

npx nx run-many --targets=serve-test-data,serve-web-api,serve,serve-fr,serve-es --projects=web-component,studio-web --parallel 6

which is supposed to run everything, I get an error because version.ts has not been generated.

joanise commented 3 months ago

In the generated HTML file, I'm not clear on what exactly we want in the meta tags... Right now, you added <meta name="version" content="1.4.0"> but it's not clear what that's the version of.

We talked about injecting something reflecting what software was used to generate the readalong, were we going to put that in these html meta tags, or in the .readalong? (Or both?)

This is nice work, don't get me wrong, I just have to wrap my brain around what we actually need in here!

deltork commented 3 months ago

In the generated HTML file, I'm not clear on what exactly we want in the meta tags... Right now, you added <meta name="version" content="1.4.0"> but it's not clear what that's the version of.

We talked about injecting something reflecting what software was used to generate the readalong, were we going to put that in these html meta tags, or in the .readalong? (Or both?)

This is nice work, don't get me wrong, I just have to wrap my brain around what we actually need in here!

Both! I have changed the HTML meta tag from version to generator. This is good for archiving