JupiterBroadcasting / JupiterBroadcasting/jupiterbroadcasting.com

Using HedgeDoc to help generate RSS (Podcasting 2.0)

Open
#523 2 comments 0 reactions 0 assignees View on GitHub
enhancement P2.0 research
Dominant language
Sass
Stars
103
Forks
49
Avg merge
3h 42m
Merged PRs (30d)
20

Description

### Feature Description

Based on my comment [in Matrix](https://matrix.to/#/!rDlEtonuSythLzmxQL:jupiterbroadcasting.com/$lojyvYkgCxary6_ewQBLmcZs89vNTXEl37m31YZRP8Q):

> You mentioned posting it to a GitHub repo from your notes doc...what if (tl;dr version) we could reach into the notes doc and just grab all the episode information...🤔
> That way you don't have to publish the information anywhere else because you (and JB team) already did all the hard work to create that notes doc. Plus, it's already in Markdown, so the only thing would be to make sure it's in the expected format (we can talk more about that) and let the automation take care of the rest 😁

### Summary
I wanted to see if it was possible to use [HedgeDoc's API](https://docs.hedgedoc.org/dev/api/) (the current JB note platform) to grab the JB show notes and then we can parse the markdown file to generate the RSS feed from that document.

### Details
So, it would act just like the scrapper to where it's an automated process in the GH repo, but could be manually invoked (via GUI or API). This process would just be yet another way to push data to the repo so we can deploy episodes (we'll have to figure out about the scrapper collisions)

IIRC, JB uses Hedgedoc and it looks like they have an [API](https://docs.hedgedoc.org/dev/api/). So there could be a single note and maybe that note has the ID or link to the show which needs to be publish + a date/time it need to be published by. This would help control which episode is getting released and making sure it's not getting published too early. This also helps with the not disclosing information on a public repo too early, because you don't have anything you need to do 🙃

##### Small Security Side-note
There is technically an attack vector here for someone who has write access to the repo and trying to pull other notes from the Hedge doc instance, but we already have that with the SSH key to a JB server. (BTW as we expand the JB website's reach into the JB infra [this](https://blog.elreydetoda.site/github-action-security/) is going to be more important, and I would be happy to help set it up with you and the team - this will help prevent the attack because people with write vs people who can approve can be different)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.