10up / simple-podcasting

A simple podcasting solution for WordPress.
https://wordpress.org/plugins/simple-podcasting/
GNU General Public License v2.0
185 stars 30 forks source link

Adds transcript block and meta #221

Closed nateconley closed 12 months ago

nateconley commented 1 year ago

Description of the Change

Adds a block that saves the transcript to post meta and allows editor to either link to the transcript, display the transcript, or only have the transcript accessible via the endpoint.

Closes #28

TODO:

Alternate Designs

This approach is as a block, also discussed were this functionality a meta field.

Possible Drawbacks

This approach does not account for the classic editor.

Verification Process

Checklist:

Changelog Entry

Added - Podcast transcripts

Credits

@nateconley

nateconley commented 1 year ago

Hi @peterwilsoncc ! This is now ready for review. There is much more discussion on the approach to this in the original issue thread: #28

I added two unit tests, but my functions do not have full coverage. I'm happy to add more if given a bit of direction. I did not add any new E2E tests. Again, happy to add those in if you can tell me what coverage you'd like to see.

When building the new transcript block, I tried to write the block using a more updated approach to block-building without changing the original block methodology (except when I did make an addition to those files, the prettier config made some formatting edits).

One thing to note is that this update will require flushing rewrite rules. How do you usually like to approach that? Upgrade instructions? Upgrade routine?

nateconley commented 1 year ago

@peterwilsoncc I left a comment on one of your concerns. I do not have time until at least two weeks from now to dig into this more.

jeffpaul commented 1 year ago

@10up/open-source-practice this could use some help getting conflicts resolved, final review, and merging

nateconley commented 1 year ago

Quick update: I will have all comments addressed here by EOW.

nateconley commented 1 year ago

@peterwilsoncc This is ready for a re-review.

nateconley commented 1 year ago

I could also use a bit of help with the failing e2e tests. It looks like those might be caused by a missing dependency.

peterwilsoncc commented 1 year ago

Sorry Nate, I'm still having problems while testing.

If I start a citation within a transcript block then the editor stays as a citataion after I press return

cite

Reviewing some documentation, it looks like having them as blocks rather than inline is a good improvement.

nateconley commented 1 year ago

@peterwilsoncc Thanks for the catch! I have modified the cite and time inner blocks to behave similar to other core blocks; when you press return a paragraph block is created.

Again, looks like cypress test are failing, but this seems unrelated to this branch from what I can see.