JupiterBroadcasting
Show Notes Links to GitHub Gists (Solution for Quick Notes During/After Show?)
Feature Description
Boost: Request for Steps of Creating / Configuring Fun New Tech Described in Episodes (Example was SimpleX Server)
I was listening to Episode 506: Three Wild and Crazy Topics and the boosts section included a request for notes on how to perform the task discussed.
I was thinking perhaps linking to a Gist might give enough flexibility but also keep the barrier to entry low enough for the community to help keep it updated (or could even just say “as of … this is accurate”).
Just a quick sample:
https://gist.github.com/curtisspendlove/4d8e5a77407e67cdcade97d6b4c20cc6
Pro/Con
- pro - lower barrier to update; even during live show
- con - potentially bypasses code review steps (which could lead to data inaccuracy)
Reference to Feature
No response
Original Matrix conversation (Fluffy Chat web client didn't give me a link that I could find)
Curtis Spendlove: So … I was listening to the recent boost about building a “website” for instructions about configuring things (I think it referenced nextCloud). But I was wondering if maybe linking to GitHub Gists would be sufficient. I’m pretty sure you can add Markdwon and it would represent code very well for configs, Docker, etc. just a thought.
Curtis Spendlove: Oh, it was SimpleX sorry.
Curtis Spendlove: re: Boosts Chapter of 506 https://linuxunplugged.com/506
CG_BassPlayer: > <@knightoftheoldcode:matrix.org> So … I was listening to the recent boost about building a “website” for instructions about configuring things (I think it referenced nextCloud). But I was wondering if maybe linking to GitHub Gists would be sufficient. I’m pretty sure you can add Markdwon and it would represent code very well for configs, Docker, etc. just a thought.
So gists are more like the code blocks in markdown than a markdown file itself. I know obsidian has a plug-in to render gists in a markdown document so I would imagine the JS under the hood could be translated to a site fairly easily
Curtis Spendlove: Yeah I was thinking more in the way of something that could be pretty easily modified by the community to stay up to date but still be linked as a small, simple “how we created the SimpleX server config” kinda thing. A way to decouple from the full site rebuild process.
Curtis Spendlove: Since they can be an .md file with codeblocks / code fences. :: shrug ::
CG_BassPlayer: Definitely a cool idea! I am not totally sure about community updates to a gist (personally haven't tried updating a public gist) but my only concern would be a gist getting updated to something that isn't correct and would not have gone through the review process like our other PRs do. But I think the idea of having a an area of the site where configs for things JB talks about would be really interesting! If you would like, you can open an issue about it on the website repo!
https://github.com/JupiterBroadcasting/jupiterbroadcasting.com/issues/new/choose
Curtis Spendlove: Yeah I figured I’d mention it here first before I clogged up an issue number. I was thinking something like this:
https://gist.github.com/curtisspendlove/4d8e5a77407e67cdcade97d6b4c20cc6
But it’s a good point too about it being updated without review. :: shrug ::
Curtis Spendlove: I’m honestly kinda surprised there isn’t w GUI option for a quick revert in the revisions tab.
Curtis Spendlove: Or maybe there is but not on a mobile browser.
CG_BassPlayer: I’ll have to look at gist a little more because I originally thought it was just for sharing code snippets. Didn’t know you could have actually markdown there. Very cool.
CG_BassPlayer: > <@knightoftheoldcode:matrix.org> I’m honestly kinda surprised there isn’t w GUI option for a quick revert in the revisions tab.
I don’t remember off hand if they have a quick revert button, but it would be really good if they did. But like I said, I haven’t used them enough to know if users other than the author of the gist can even edit it
Curtis Spendlove: Yeah I love Gists but I don’t use them as much as I should.
Curtis Spendlove: https://github.com/JupiterBroadcasting/jupiterbroadcasting.com/issues/541
CG_BassPlayer: I mean now that it is in an issue, we definitly discuss the pros and cons
Curtis Spendlove: > <@cg_bassplayer:matrix.org> I don’t remember off hand if they have a quick revert button, but it would be really good if they did. But like I said, I haven’t used them enough to know if users other than the author of the gist can even edit it
Good point. I know there can be comments which is pretty cool too.
CG_BassPlayer: If the Gist part doesn't work out, I think the idea of having basic configs would be really cool. Kind of like a one stop shop of configs for new tech, but on the other hand, we could also link to the documentation of project providing an example when applicable
CG_BassPlayer: Just trying to think about both sides
Curtis Spendlove: Yeah. It resonated with me a bit due to Chris saying he liked the idea. But it is a case of “where’s the JB community value” too.
Curtis Spendlove: And … maybe it’s not a LUP thing … maybe the Self Hosted subcommunity is a better one to maintain it or whatever. Dunno. Kinda just thinking in text as it were.
CG_BassPlayer: I do think its a cool idea, but I am also 1 person. I will update the issue with our conversation and we will see if others like the idea. You could even share the issue link with the JB Chat to get some eyes on it?
The idea of using Gist is an interesting one, but I am not sure if users can edit gists that were authored by someone else. But the idea of having a small section of site for sharing common configurations for services would be pretty cool.
Not sure if it is the most practical since the documentation of a project or service should be the go to place for things like that, but if the community is interested in an idea like this, I am all for it!
Yeah. I’m also not convinced that it’s the best option either. Chris seemed interested in the feature, so figured I’d capture it since I had a bit of time and have been wanting to get involved in helping the network for a while.
I’m not opposed to editing the Issue title to be less specific either. 🤷♂️😬🤣
a small section of site for sharing common configurations for services would be pretty cool
I wonder if we could utilize the Self Hosted Wiki to hold that kind of information. The repo for the wiki is here and looks like it only has a few pages on it. But I think that would be a better place to store that kind of information.
It doesn't seem like they want to get config examples there (they seem to link to the documentation sites like I was saying). But seems like some of the pages do provide some notes on some getting started steps or some next steps after getting it running. Update: I reviewed there contributing and they do not want configurations that are copy and paste.
Personally I think this would be a better route than the Gists (not that it was a bad idea!) but I want to know what others are thinking