uftrace icon indicating copy to clipboard operation
uftrace copied to clipboard

Official web page for uftrace for better accessibility.

Open kangtegong opened this issue 2 years ago • 6 comments

Currently there is no official webpage for uftrace (except for slide and man pages). It think we can apply readthedocs like below

https://uftrace.readthedocs.io/

or make custom github page for uftrace.

Personally, I think readthedocs is good because it can generate website based on markdowns (or rst files) under doc/ directory.

But if readthedocs invoke lots of changes in uftrace repository or readability is not good enough, custom github page is also fine.

kangtegong avatar May 09 '22 09:05 kangtegong

Sounds good. I'm not familiar with that but current README and manpage should be fine.

@honggyukim what do you think?

namhyung avatar May 13 '22 18:05 namhyung

That will be good. But I hope we can use https://uftrace.github.io instead of https://uftrace.readthedocs.io just like https://docs.kernel.org if possible.

Besides that, I think we better move some documents with good quality to our source repo instead of having them in wiki. For example, https://github.com/namhyung/uftrace/wiki/Data-Format. It's because

  1. we don't really update the documents in our wiki.
  2. documents can be better synced with source changes.
  3. external contributors will likely to contribute as it can be counted in the commit history while wiki update doesn't.

honggyukim avatar May 20 '22 17:05 honggyukim

I totally agree with @honggyukim :) Thanks.

kangtegong avatar May 21 '22 05:05 kangtegong