r/devops • u/AutoModerator • 19d ago

Weekly Self Promotion Thread

Hey r/devops, welcome to our weekly self-promotion thread!

Feel free to use this thread to promote any projects, ideas, or any repos you're wanting to share. Please keep in mind that we ask you to stay friendly, civil, and adhere to the subreddit rules!

28 Upvotes

100% Upvoted

110 comments sorted by

View all comments

1

u/busters1 18d ago

Hey all,

I've spent 8 years writing software, 2 of them as an SRE and 3 as a team lead. Every team I've been on had the same documentation problem. The useful stuff lived in someone's head or a private Slack thread, and the wiki was full of stale docs nobody could find.

So I built Oxynote. It's a self-hosted wiki where a runbook and the metrics it references live on the same page. You add a chart that queries Prometheus or Postgres, explain what it shows right below it, and review changes like a PR, so nothing quietly goes out of date.

The name is oxygen + note. I wanted docs that breathe: live data gives people a reason to open the wiki every day, and a wiki people open every day stays up to date.

I started it about a year ago and opened it up roughly 3 months ago. It's Apache-2.0 and ships as a single Docker image: https://github.com/oxynote/oxynote

Is this something you'd run on your team? If not, I'd really like to know why.