redbpf icon indicating copy to clipboard operation
redbpf copied to clipboard

A proper place to serve RedBPF guide documentation

Open rhdxmr opened this issue 4 years ago • 2 comments

It is convenient to write document in markdown and it is easy to serve it via github repo. But it is hard to organize multiple documents with github repo interface.

It would be nice to serve RedBPF guide documentation in a proper place other than github repo. But we do not discuss a standard way of doing this yet. At least for me, I don't know where to write RedBPF guide documentation.

How about discussing this issue?

rhdxmr avatar Oct 10 '21 16:10 rhdxmr

I think the right place to put these is the foniod.org/docs website. On git push, the CI will build the static site with gohugo.io, so what we serve is pretty flexible. Do you think this could work?

rsdy avatar Oct 10 '21 17:10 rsdy

It seems great. foniod.org site is a suitable place to maintain the documentation. And I like the documentation is version controlled by git.

There's one thing to solve before uploading the documentation. We should find the best way to display the RedBPF guide documentation without mixing the doc of foniod itself. If they are mixed up, the users would be confused and they could not find what they want to read.

rhdxmr avatar Oct 11 '21 01:10 rhdxmr