I’ve recently made a small update to my blog, and I’d like to share the how, the why and the what. I’m also going to take the time and ask you to provide me some feedback on my posts from now on, since this small update enhances just that.
First things first, what is it?
Well, see the little bar on the bottom that follows your scrolling?
Have you hovered around it yet? It’s simply a shorthand for creating a new GitHub Issue on my repository (current issues). I’m planning to use Github Issues with some useful labels as a feedback system.
Think about it for a second. This blog is hosted on Github Pages, with Jekyll, so a Github Repository is the means to do it. Github Repositories have Github Issues enabled. When you make a new commit, you can reference an issue, and the other way around, an issue can reference a commit. It’s the perfect integration.
When someone has something they might want to add to improve the post itself, or just leave feedback, they’re welcome to do so with issues to ensure that the changes end up in the post.
For everything else there’s the comments section.
That’s the easy bit. I just created some labels specifically for posts, and used those. Linking the buttons to Github Issues was done with URLS of the type:
https://github.com/sabinmarcu/sabinmarcu.github.io/issues/new?title=Issue with "<POST>"&assignee=<ME/USERNAME>&labels=<LABEL 1>&labels=<LABEL 2>[...]
This way, the assignee, post title and correct labels are pre-filled and the person just needs to login with his Github account (gets rid of spam, too) and carry on with the body of the issue.
Hey, I’m a dev. Most of my friends and readers are devs. I expect most people that would use this feature to have Github to begin with.
That’s it for today
Until next time, ‘ave a good one!