Thursday, June 5, 2025

F1x - wiki for devops

By definition devops role requires 24/7 on-demand attention. With separate NOC team to execute SOPs and track incidents. Single devops is nonsense. A company that has single devops is a recipe for disaster as there is no redundancy for that fragile and pesky human resource.

With more than one devops, knowledge sharing becomes the issue. And without further ado, let me introduce F1x - how we handle it in our company:

F1x

Have you ever wondered about possibility to press F1 and have a way to scribble notes about the very thing you are working on? And make these notes available to other members of your team? Popping up into their face when they happen to start working onto the same thing? And they can edit them too!

Introducing F1x - "F1+eXtra help button everywhere":

F1x is "F1 help button everywhere" system that recognizes user activity (context) and maps contexts and corresponding wiki pages.

At this stage it is able to track contexts of users doing ssh to servers and changing current path into a directory. But it already gives powerful notes-leaving mechanism:

Imagine you are trying to understand some weird functionality and ssh into the server. A popup shows up with a note that there is F1x note. You press F1 and browser is opened to the F1x wiki page, that is exactly about the server you are working on. Even more, when you chdir into some directory, and there is a note about it, you will get popup as well.

Here is short video demo of the F1x in action:




More info and code is on the gitlab project over here:
https://gitlab.com/skliarie/f1x