se-unlocked VS Hugo

As I was exploring this podcast's open-source contributions, I found an issue that piqued my interest. This issue, related to episode 47, focused on how to enhance the transcripts of the episodes. The author needed help improving the clarity and understanding of these transcripts.

Hey, great list of awesome podcasts. I’m the host of Software Engineering Unlocked https://www.se-unlocked.com.

The episodes focus on the experience of my guests with software engineering practices such as testing, or code review, their journey to advance their career and often also on how developers build their successful business.

Would love if you give it a listen and see if you like my show.

For my last PR, I contributed to the se-unlocked repo which manages the transcripts for the Software Engineering Unlocked podcast.

During Hacktoberfest 2021, I was browsing and looking for an open source to contribute to. I only had a little time at that time. So, I limited my search to accessibility and documentation issues. And that was when I found an accessibility issue. It was on Michaela Greiler's Software Engineering Unlocked Podcast repository.

For part three, I decided to take on a different kind of issue - to improve transcript for a podcast episode. The process was similar to what I had done for my previous PRs. I forked the project and created a branch for the issue. However, since the work involved editing a markdown file, I decided to use GitHub's built-in editor to work on it instead. The improvement process involved listening to the episode while reading through the existing transcript. I would pause as needed and fix any issues which I notice. These mostly involved a few missing words, missing pronunciation, incorrect pronunciation, and some incorrect words. For example, git pull was transcribed as git poll, O'Reilly as a Raleigh, abstraction as obstruction. Though I was quite surprised by how accurate the auto generated transcript was. The only places where it would mess up was when there was a slight overlap in conversation, or when terms specific to software development, or names of publishers were being said. Throughout this process, I learned a bunch about transcribing - what may be ignored (phrases such as um), when to be exact, how and when to transcribe laughs, background music, etc. And once I was finished with the changes, I created a PR.

This time, I contribute to a repo from Software Engineering Unlock,a podcast for discussing topic about software engineering. They need some help to go over automatically generated transcript to correct them to improve accessibility, so I participated in the issue for one of the episodes and made a pull request.

Software Engineering Unlocked Podcast

Due to the above, the transcriptions were not exactly "accurate". To pick up an issue, all I had to do was create an issue with information about which episode I wanted to transcribe.

At one point though I realized there is a scaling problem with my build minutes. I knew that golang has considerably faster builds and in my case the easy fix is swapping over to Hugo.

This blog is running on Hugo. It had previously been running on Jekyll. Both these SSGs ship with the ability to create excerpts from your markdown content in 1 line or thereabouts.

Hugo

Hugo is a popular static site generator specifically designed to create websites and documentation lightning-fast. Its minimalist approach, emphasis on speed, and ease of use have made it popular among developers, technical writers, and anybody looking to construct high-quality websites without the complexity of typical CMS platforms.

As per many other comments, it sounds like a static site generator like Hugo (https://gohugo.io/) or Jekyll (https://jekyllrb.com/), hosted on GitHub Pages (https://pages.github.com/) or GitLab Pages (https://about.gitlab.com/stages-devops-lifecycle/pages/), would be a good match. If you set up GitHub Actions or GitLab CI/CD to do the build and deploy (see e.g. https://gohugo.io/hosting-and-deployment/hosting-on-github/), your normal workflow will simply be to edit markdown and do a git push to make your changes live. There are a number of pre-built themes (e.g. https://themes.gohugo.io/) you can use, and these are realtively straightforward to tweak to your requirements.

Create the technical documentation of your project You can use any of the following options: * A wiki, like the ArchWiki that uses MediaWiki * Read the Docs, used by projects like Setuptools. Check Awesome Read the Docs for more examples. * Create a website * Create a blog, like the documentation of Blowfish, a theme for Hugo.

Doing this made me appreciate existing SSGs like Hugo and Next.js even more👏👏

I suggest hugo: https://gohugo.io/

Generates a completely static website from MD (and other formats) files; also handles themes (including a lot of them rendering well on mobile), and different types of content - posts, articles, etc. - depending on the theme.

It's open source and, being completely static, cheap as fuck to self host.