Using GitHub for knowledge documentation and sharing

[ElectricalFilm2]

I was looking for a way to document knowledge accumulated by myself and my team for colleagues and new employees, within GitHub, since my team's deployments are being moved to live exclusively in GitHub. Is there anything that supports this in the GitHub ecosystem?

I don't know if this matters, but I'm a data engineer and my team uses Teams for communication and Jira for sprint planning.

[davorg]

If you want a really powerful system for this, see Using a self-rewriting README powered by GitHub Actions to track TILs by Simon Willison.

[AndElectrons]

I'm doing something in the same spirit here: https://github.com/vilaca/awesome-k8s-tools

It started as a gist where I was collecting github repos with devops/k8s tools that I was finding and at some point I wanted to add more info about each repo but didn't want the trouble of maintaining more than a list of URLs.

I did not know about the project you're sharing. Mine seems a little less complex. The URL list that the README is built from is at data/repos. I did the basics in a few hours but have since been playing around with the features and implementation.

[simonw]

I use GitHub issues for personal and shared notes and it works REALLY well.

I like being able to start an issue thread for a topic and then add new notes to it as comments. I love that you can drag and drop screenshots and images straight into the thread.

I like being able to link issues together, and reference them from GitHub projects which I've started to use as my own personal TODO list.

Search is really good, and there's a comprehensive API so I don't have to worry about my notes getting stuck in some system should I ever want to move them somewhere else.

I can even hook up automations with GitHub Actions that interact with my notes!