Wikibook Linux kernel
Dear Linux kernel documentation writers and readers: Writing Linux documentation is a huge complex collaborative process. To make it better I invite you to contribute to https://en.wikibooks.org/wiki/The_Linux_Kernel . Main benefits of the book: - Readers friendly architecture - Matrix table of contents - Convenient common wikimedia format - Hosted on wikibooks.org - Updateable by everyone. I've designed the front page matrix table of contents and composed draft articles with outline, links to kernel documentation, sources and other resources. Sometimes visitors of the book contribute to it. My vision is to have a complete updated wikibook about Linux kernel written by many experienced developers. Please vist page https://en.wikibooks.org/wiki/The_Linux_Kernel/About for the book desripton. Welcome to contribute to https://en.wikibooks.org/wiki/The_Linux_Kernel! Sincerely yours Constantine Shulyupin -- Constantine Shulyupin
On Thu, May 06, 2021 at 01:58:35PM +0300, Constantine Shulyupin wrote:
Dear Linux kernel documentation writers and readers:
Writing Linux documentation is a huge complex collaborative process. To make it better I invite you to contribute to https://en.wikibooks.org/wiki/The_Linux_Kernel .
You have seen this, right? https://www.kernel.org/doc/html/latest/ which is generated from the kernel repo. I'm sure Jon has even a grand idea about how to organize our documentation in an even better way. So it looks like we already have most of the topics and you could probably even generate the wikibook from the kernel documentation. :) Thx. -- Regards/Gruss, Boris. https://people.kernel.org/tglx/notes-about-netiquette
Em Thu, 6 May 2021 13:28:50 +0200 Borislav Petkov <bp@alien8.de> escreveu:
On Thu, May 06, 2021 at 01:58:35PM +0300, Constantine Shulyupin wrote:
Dear Linux kernel documentation writers and readers:
Writing Linux documentation is a huge complex collaborative process. To make it better I invite you to contribute to https://en.wikibooks.org/wiki/The_Linux_Kernel .
And btw, the licenses there are not compatible: Text is available under the Creative Commons Attribution-ShareAlike License. Pointing to: CC BY-SA 3.0 IANAL, but, AFAIKT, is not compatible with GPL version 2[1]. [1] at least, there's a comment here: https://github.com/todbot/SoftI2CMaster/issues/14 I didn't read it in full, but it seems to be endorsed by CC people: https://creativecommons.org/2015/10/08/cc-by-sa-4-0-now-one-way-compatible-w... Btw, even if this were using CC BY-SA 4.0, it would still be incompatible with GPL v2, as the one-way compatibility is just with v3. So, porting texts/documents from/to wikibooks can be an issue from legal standpoint. If you want to contribute with Kernel docs, the best way would be to send additions/improvements against the Kernel tree to the linux-doc mailing list.
You have seen this, right?
https://www.kernel.org/doc/html/latest/
which is generated from the kernel repo.
I'm sure Jon has even a grand idea about how to organize our documentation in an even better way.
So it looks like we already have most of the topics and you could probably even generate the wikibook from the kernel documentation. :)
Thx.
Thanks, Mauro
On Thu, May 06, 2021 at 01:58:35PM +0300, Constantine Shulyupin wrote:
Dear Linux kernel documentation writers and readers:
Writing Linux documentation is a huge complex collaborative process. To make it better I invite you to contribute to https://en.wikibooks.org/wiki/The_Linux_Kernel .
Main benefits of the book: - Readers friendly architecture - Convenient common wikimedia format
I know people that would disagree with these points ;-)
- Hosted on wikibooks.org - Updateable by everyone.
And this point also has dubious value. All in-tree documentation is carefully reviewed. It might be outdated, yes, but at least at the time it is written we know it is correct. This is not necessarily a case with an open wiki.
I've designed the front page matrix table of contents and composed draft articles with outline, links to kernel documentation, sources and other resources. Sometimes visitors of the book contribute to it. My vision is to have a complete updated wikibook about Linux kernel written by many experienced developers. Please vist page https://en.wikibooks.org/wiki/The_Linux_Kernel/About for the book desripton.
Welcome to contribute to https://en.wikibooks.org/wiki/The_Linux_Kernel!
If you have ideas about how to organize and improve our documentation you are welcome to contribute to Documentation/ in the kernel tree ;-) -- Sincerely yours, Mike.
On Thu, May 06, 2021 at 01:58:35PM +0300, Constantine Shulyupin wrote:
Dear Linux kernel documentation writers and readers:
Writing Linux documentation is a huge complex collaborative process. To make it better I invite you to contribute to https://en.wikibooks.org/wiki/The_Linux_Kernel
There are some wiki's that are available at *.wiki.kernel.org. For example, ext4.wiki.kernel.org. We've largely abandoned it, in favor of using Documentation in the kernel sources, because if you leave it "updated by anyone", unless you have people constantly watching for spam or trash updates which have to be reverted, it quickly becomes a mess. Or you can keep tight control over who you give accounts to, but then it doesn't get updated all that often. Keeping the documentation in sync with the kernel sources means it's much more likely for the documentation to be updated when the kernel is updated, and so for example we've migrated: https://ext4.wiki.kernel.org/index.php/Ext4_Disk_Layout to: https://www.kernel.org/doc/html/latest/filesystems/ext4/index.html with the sources available at: https://git.kernel.org/pub/scm/linux/kernel/git/tytso/ext4.git/tree/Document... ... and been much happier with the result. Cheers, - Ted
Thank you, Ted, for pointing to https://wiki.kernel.org/. Out of 29 wikis 8 are outdated. Here is a summary: https://en.wikibooks.org/wiki/The_Linux_Kernel/wikis Regards On Thu, 6 May 2021 at 17:18, Theodore Ts'o <tytso@mit.edu> wrote:
On Thu, May 06, 2021 at 01:58:35PM +0300, Constantine Shulyupin wrote:
Dear Linux kernel documentation writers and readers:
Writing Linux documentation is a huge complex collaborative process. To make it better I invite you to contribute to https://en.wikibooks.org/wiki/The_Linux_Kernel
There are some wiki's that are available at *.wiki.kernel.org. For example, ext4.wiki.kernel.org. We've largely abandoned it, in favor of using Documentation in the kernel sources, because if you leave it "updated by anyone", unless you have people constantly watching for spam or trash updates which have to be reverted, it quickly becomes a mess. Or you can keep tight control over who you give accounts to, but then it doesn't get updated all that often.
Keeping the documentation in sync with the kernel sources means it's much more likely for the documentation to be updated when the kernel is updated, and so for example we've migrated:
https://ext4.wiki.kernel.org/index.php/Ext4_Disk_Layout
to:
https://www.kernel.org/doc/html/latest/filesystems/ext4/index.html
with the sources available at:
https://git.kernel.org/pub/scm/linux/kernel/git/tytso/ext4.git/tree/Document...
... and been much happier with the result.
Cheers,
- Ted
-- Constantine Shulyupin
participants (5)
-
Borislav Petkov -
Constantine Shulyupin -
Mauro Carvalho Chehab -
Mike Rapoport -
Theodore Ts'o