Technical Writing / Updating Documentation

[Yuri Chornoivan]

неділя, 25 грудня 2022 р. 01:45:33 EET Aaron L написано:
> Hi Yury,
> 
> I will take a look. Other documentation first.
> 
> Why is KDE using two different methods?

That's the multilevel question.

1. Some hope that the new (other) publication system allows them to rewrite 
old docs in the modern way.

2. Some believe that DocBook is hard to understand and frighten potential 
writers.

3. Some think that Sphinx is easier to adopt and manage.

Best regards,
Yuri

> 
> Best,
> Aaron
> 
> On Sat, Dec 24, 2022 at 8:32 AM Yuri Chornoivan <yurchor at ukr.net> wrote:
> > > Hi Yury,
> > > 
> > > I will read the following to get an understanding of the processes:
> > > 
> > > <goog_357313387>
> > > https://community.kde.org/Get_Involved/documentation
> > > 
> > > <goog_357313392>
> > > https://l10n.kde.org/docs/doc-primer/
> > > 
> > > Let me know if there's anything else I should be reading.
> > > 
> > > Best,
> > > Aaron
> > 
> > Yes, that's the main part. But now we have three major projects (Krita,
> > Kdenlive and digiKam) that use markdown for their docs:
> > 
> > https://www.markdownguide.org/basic-syntax/
> > 
> > It's good to take this into account.
> > 
> > Best regards,
> > Yuri
> > 
> > On Fri, Dec 23, 2022 at 7:15 AM Yuri Chornoivan <yurchor at ukr.net>
> > 
> > wrote:
> > > пʼятниця, 23 грудня 2022 р. 14:07:54 EET Aaron L написано:
> > > > Hi,
> > > > 
> > > > I'm looking to help out with some documentation.
> > > > 
> > > > What is currently being done?
> > > > 
> > > > I see there's a few applications that need some documentation work.
> > > > 
> > > > Best,
> > > > Aaron
> > > 
> > > Hi,
> > > 
> > > Actually the situation is not that bright. We have several applications
> > > that
> > > were updated for 22.12 without syncing their documentation.
> > > 
> > > Spectacle
> > > Gwenview
> > > Okular
> > > Kate/Kwrite
> > > 
> > > Those need careful investigation. Now the major overhaul of digiKam
> > > documentation happens and we need to track this at some point.
> > > 
> > > https://invent.kde.org/documentation/digikam-doc/-/tree/sphinx
> > > 
> > > That's just my partial point of view.
> > > 
> > > Best regards,
> > > Yuri
> > > 
> > > > On Fri, Dec 23, 2022, 2:08 AM Yuri Chornoivan <yurchor at ukr.net>
> > 
> > wrote:
> > > > > пʼятниця, 23 грудня 2022 р. 01:04:51 EET Aaron L написано:
> > > > > > Hi there,
> > > > > > 
> > > > > > I am reaching out as I would like to assist with writing and
> > 
> > updating
> > 
> > > > > some
> > > > > 
> > > > > > of the KDE application documentation. I have roughly ~7-8 years of
> > > > > 
> > > > > writing
> > > > > 
> > > > > > and editing experience.
> > > > > > 
> > > > > > I have a computer with KDE (Kubuntu 22.04) installed.
> > > > > > 
> > > > > > Currently, I am reading the primer documentation.
> > > > > > 
> > > > > > Looking forward to hearing from you!
> > > > > > 
> > > > > > Best,
> > > > > > Aaron
> > > > > 
> > > > > Hi,
> > > > > 
> > > > > Welcome aboard!
> > > > > 
> > > > > Please do not hesitate to ask any questions (and subscribe to the
> > > 
> > > mailing
> > > 
> > > > > list
> > > > > [1]).
> > > > > 
> > > > > Thanks in advance for your help.
> > > > > 
> > > > > Best regards,
> > > > > Yuri
> > > > > 
> > > > > [1] https://mail.kde.org/mailman/listinfo/kde-doc-english