[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-devel
Subject: kdesrc-build tutorial moved to develop.kde.org
From: Thiago Masato Costa Sueto <herzenschein () gmail ! com>
Date: 2024-03-18 21:59:41
Message-ID: CAA=uvBeHgaJ2SitiVaCXCA7B6NcdnD9ACM0ogHXc--h0KqhCKw () mail ! gmail ! com
[Download RAW message or body]
Hi everyone,
Due to relatively recent events concerning the development tutorials, I've
ported most of the kdesrc-build tutorial from the Community wiki[1] over to
Develop[2]. This email is to notify you all.
The port was also done to make the text friendlier and more presentable, as
some parts had vital information but were not presented as well as they
could be.
While this means the Community wiki is no longer the single hub entrypoint
for all Get Involved pages, this also means that:
* We now have a review process to ensure the quality of our development
tutorials
* It's more difficult to introduce "content creep", when there's a gradual
increase of information that isn't strictly necessary to be there
* Building KDE software is no longer far away from the place where you'd
read about how to write KDE software
* The content is written in Markdown (much nicer than MediaWiki) with
nicely documented formatting and styling guidelines[3]
* The UX should be nicer, as everything is linked properly, there are two
sidebars to navigate, missing links can be tested in CI
* It's effectively docs-as-code[4]
* The tutorial is more easily extensible, as it's no longer designed solely
around kdesrc-build and allows for more content (like containers, VMs,
Craft) in a single section
So far only the essentials for building with kdesrc-build have been ported.
Information such as "how do I integrate kdesrc-build with my IDE?" or "how
do I build with containers?" can be added later (Develop is set up to
accomodate for those easily).
This has been made possible by standing on the shoulders of giants, namely
the people who added the contents to the wiki in the first place, but it
also means it's a lot of content to port completely. I'll be updating the
Kirigami and Plasma tutorials to Qt6 at around the same timeframe, so it
might take a while.
[1] - https://community.kde.org/Get_Involved/development
[2] - https://develop.kde.org/docs/getting-started/building/
[3] - https://develop.kde.org/docs/contribute/
[4] - https://www.writethedocs.org/guide/docs-as-code/
[Attachment #3 (text/html)]
<div dir="ltr"><div class="gmail_default" style="font-size:large">Hi \
everyone,</div><div class="gmail_default" style="font-size:large"><br></div><div \
class="gmail_default" style="font-size:large">Due to relatively recent events \
concerning the development tutorials, I've ported most of the kdesrc-build \
tutorial from the Community wiki[1] over to Develop[2]. This email is to notify you \
all.<br></div><div class="gmail_default" style="font-size:large"><br></div><div \
class="gmail_default" style="font-size:large">The port was also done to make the text \
friendlier and more presentable, as some parts had vital information but were not \
presented as well as they could be.<br></div><div class="gmail_default" \
style="font-size:large"><br></div><div class="gmail_default" \
style="font-size:large">While this means the Community wiki is no longer the single \
hub entrypoint for all Get Involved pages, this also means that:</div><div \
class="gmail_default" style="font-size:large"><br></div><div class="gmail_default" \
style="font-size:large">* We now have a review process to ensure the quality of our \
development tutorials</div><div class="gmail_default" \
style="font-size:large"><br></div><div class="gmail_default" \
style="font-size:large">* It's more difficult to introduce "content \
creep", when there's a gradual increase of information that isn't \
strictly necessary to be there</div><div class="gmail_default" \
style="font-size:large"><br></div><div class="gmail_default" \
style="font-size:large">* Building KDE software is no longer far away from the place \
where you'd read about how to write KDE software</div><div class="gmail_default" \
style="font-size:large"><br></div><div class="gmail_default" \
style="font-size:large">* The content is written in Markdown (much nicer than \
MediaWiki) with nicely documented formatting and styling guidelines[3]</div><div \
class="gmail_default" style="font-size:large"><br></div><div class="gmail_default" \
style="font-size:large">* The UX should be nicer, as everything is linked properly, \
there are two sidebars to navigate, missing links can be tested in CI</div><div \
class="gmail_default" style="font-size:large"><br></div><div class="gmail_default" \
style="font-size:large">* It's effectively docs-as-code[4]</div><div \
class="gmail_default" style="font-size:large"><br></div><div class="gmail_default" \
style="font-size:large">* The tutorial is more easily extensible, as it's no \
longer designed solely around kdesrc-build and allows for more content (like \
containers, VMs, Craft) in a single section</div><div class="gmail_default" \
style="font-size:large"><br></div><div class="gmail_default" \
style="font-size:large">So far only the essentials for building with kdesrc-build \
have been ported. Information such as "how do I integrate kdesrc-build with my \
IDE?" or "how do I build with containers?" can be added later (Develop \
is set up to accomodate for those easily).<br></div><div class="gmail_default" \
style="font-size:large"><br></div><div class="gmail_default" \
style="font-size:large">This has been made possible by standing on the shoulders of \
giants, namely the people who added the contents to the wiki in the first place, but \
it also means it's a lot of content to port completely. I'll be updating the \
Kirigami and Plasma tutorials to Qt6 at around the same timeframe, so it might take a \
while.<br></div><div class="gmail_default" style="font-size:large"><br></div><div \
class="gmail_default" style="font-size:large">[1] - <a \
href="https://community.kde.org/Get_Involved/development">https://community.kde.org/Get_Involved/development</a></div><div \
class="gmail_default" style="font-size:large">[2] - <a \
href="https://develop.kde.org/docs/getting-started/building/">https://develop.kde.org/docs/getting-started/building/</a></div><div \
class="gmail_default" style="font-size:large">[3] - <a \
href="https://develop.kde.org/docs/contribute/">https://develop.kde.org/docs/contribute/</a></div><div \
class="gmail_default" style="font-size:large">[4] - <a \
href="https://www.writethedocs.org/guide/docs-as-code/">https://www.writethedocs.org/guide/docs-as-code/</a></div></div>
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic