From: Yunseong Kim <yskelg@gmail.com>
To: Namhyung Kim <namhyung@kernel.org>,
Arnaldo Carvalho de Melo <acme@kernel.org>,
Ian Rogers <irogers@google.com>,
linux-perf-users <linux-perf-users@vger.kernel.org>
Cc: linux-doc@vger.kernel.org, Austin Kim <austindh.kim@gmail.com>,
MichelleJin <shjy180909@gmail.com>,
Yeoreum Yun <ppbuk5246@gmail.com>, Jiri Olsa <olsajiri@gmail.com>
Subject: publish: perfwiki.github.io/main
Date: Sat, 10 Aug 2024 14:11:36 +0900 [thread overview]
Message-ID: <7f2b1c74-4087-4da4-94eb-51d37f3d8fc2@gmail.com> (raw)
Hello everyone,
I’ve migrated the content from
Link: https://perf.wiki.kernel.org/
to markdown format.
You can now access it here:
Link: https://perfwiki.github.io/main/
All the pages listed under have been migrated.
Link: https://perf.wiki.kernel.org/index.php?title=Special%3AAllPages&from=&to=&namespace=0
We haven’t been able to log in or sign up on
perf.wiki.kernel.org
for several months now, despite it being a valuable resource for many
Linux users. I don’t know much about how the perf wiki is managed,
including any automated backups or the updates of man pages to the wiki.
Using the mkdocs framework, my knowledge of markdown, my keyboard,
and my efforts of finger, I’ve converted the MediaWiki format documentation
from perf.wiki.kernel.org into markdown.
I believe this was a worthwhile effort for me, especially
considering that it serves as a backup of the valuable content on
the perf wiki at this point in time.
Linus once said, "Talk is cheap. Show me the code." While I haven’t
been around for long, I understand that telling others what to do without
taking action oneself is not the best way to give feedback. When I looked
into it, the last edits, aside from the bot-built manual documents,
were made in May. Someone can check the recently changed pages, although
I found that it’s not easy to review the past change of history in MediaWiki.
I noticed from the perf mailing list that there were issues with
logging in, and it seems the door lock is still broken with no sign
of it being fixed. This motivated me to start this migration.
I wasn’t sure how long we’d have to wait to regain login access.
I hope you see this in a positive work and not as an act of rebellion
against using the original wiki. I genuinely believe this was the
best action I could take.
This situation also made me wonder: Is it really a good idea for a
wiki, which is linked to the kernel and serves as an official
reference, to be updated without review from others through the
mailing list?
While it might be convenient, during the migration,
I found quite a few documents that were linked for future additions
but never actually created.
With a review process through the
mailing list, I believe the documentation could have been more
systematically organized.
One thing we need to check is the licensing of the original wiki
content. The existing documents do not clearly specify their licenses.
If you find any discrepancies or issues with the migrated documents
compared to the originals, please let me know. While migrating, I
also fixed some errors in the original documents. If the original is
correct and the migrated document seems off, it’s likely due to a
mistake on my part—no AI was involved, just my fingers. Or perhaps I
was just tired. :)
I wasn’t sure if GitHub or GitLab was better, so for now, it’s
hosted on GitHub. I plan to mirror it on GitLab as well:
perfwiki.gitlab.io/main/
The CI pipeline for building man pages still needs to be
implemented. I’ll work on that when I have time.
I’d appreciate any feedback and would love to hear any ideas for
improvement.
P.S. I also think it would be great if the markdown documents from
the perf wiki could be viewed offline in a TUI.
Warm regards,
Yunseong Kim
next reply other threads:[~2024-08-10 5:11 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-08-10 5:11 Yunseong Kim [this message]
2024-08-25 5:06 ` publish: perfwiki.github.io/main Ian Rogers
2024-08-27 5:49 ` publish: perfwiki.github.io Yunseong Kim
2024-08-30 16:29 ` publish: perfwiki.github.io/main Howard Chu
2024-08-31 9:46 ` Yunseong Kim
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=7f2b1c74-4087-4da4-94eb-51d37f3d8fc2@gmail.com \
--to=yskelg@gmail.com \
--cc=acme@kernel.org \
--cc=austindh.kim@gmail.com \
--cc=irogers@google.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-perf-users@vger.kernel.org \
--cc=namhyung@kernel.org \
--cc=olsajiri@gmail.com \
--cc=ppbuk5246@gmail.com \
--cc=shjy180909@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).