Re: Technical Writing / Updating Documentation
On Tuesday, December 27, 2022 2:02:26 PM CST Aaron L wrote:
> I updated my computer running KDE today and noticed under the help
> application the following:
>
> Multiple instances of Discover (showing it multiple times)
I have an instance of Kubuntu on my hard disk. The stock version showed four
copies of "Discover" in the Application Manuals --> System menu. I tracked
this down, and corrected it by editing 3 .desktop files.
In /usr/share/applications/{org.kde.discover.desktop,
org.kde.discover.snap.desktop, org.kde.discover.urlhandler.desktop}
Remove the line "X-DocPath=plasma-discover/index.html" from all three files.
After doing this, "Discover" only shows up once in Application Manuals -->
System.
Notice that the help file /usr/share/doc/plasma-discover/index.html does not
exist on my instance of Kubuntu. I poked around the KDE Gitlab and found the
Discover project, but there aren't any docbook files. So I guess the
documentation for Discover has never been written. I'm not real sure how the
.desktop files are generated; I only noticed one such file in the Gitlab repo.
--
David Bryant
Canyon Lake, Texas
https://davidcbryant.net
signature.asc
Description: This is a digitally signed message part.
Re: Technical Writing / Updating Documentation
вівторок, 27 грудня 2022 р. 22:02:26 EET Aaron L написано: > Gotcha. > > I updated my computer running KDE today and noticed under the help > application the following: > > Multiple instances of Discover (showing it multiple times) Do not have Discover installed, but it looks like a bug ub khelpcenter or packaging bug. It cannot be fixed by documenting. > > I noticed the Virtual Desktop instructions was missing instructions as > well. Yes. The module help should be updated. Best regards, Yuri > > Let me know if this is just on my end or if you see this as well. > > On Sun, Dec 25, 2022 at 1:39 AM Yuri Chornoivan wrote: > > неділя, 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 wrote: > > > > > Hi Yury, > > > > > > > > > > I will read the following to get an understanding of the processes: > > > > > > > > > > > > > > > https://community.kde.org/Get_Involved/documentation > > > > > > > > > > > > > > > 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 > > > > > > > > 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 > > > > > > > > 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
Re: Technical Writing / Updating Documentation
Gotcha. I updated my computer running KDE today and noticed under the help application the following: Multiple instances of Discover (showing it multiple times) I noticed the Virtual Desktop instructions was missing instructions as well. Let me know if this is just on my end or if you see this as well. On Sun, Dec 25, 2022 at 1:39 AM Yuri Chornoivan wrote: > неділя, 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 wrote: > > > > Hi Yury, > > > > > > > > I will read the following to get an understanding of the processes: > > > > > > > > > > > > https://community.kde.org/Get_Involved/documentation > > > > > > > > > > > > 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 > > > > > > 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 > > > > > > 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 > > > > >
Re: Technical Writing / Updating Documentation
неділя, 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 wrote: > > > Hi Yury, > > > > > > I will read the following to get an understanding of the processes: > > > > > > > > > https://community.kde.org/Get_Involved/documentation > > > > > > > > > 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 > > > > 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 > > > > 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
Re: Technical Writing / Updating Documentation
Hi Yury, I will take a look. Other documentation first. Why is KDE using two different methods? Best, Aaron On Sat, Dec 24, 2022 at 8:32 AM Yuri Chornoivan wrote: > > Hi Yury, > > > > I will read the following to get an understanding of the processes: > > > > > > https://community.kde.org/Get_Involved/documentation > > > > > > 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 > 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 > 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 > > > > > > > > > > > > >
Re: Technical Writing / Updating Documentation
> Hi Yury, > > I will read the following to get an understanding of the processes: > > > https://community.kde.org/Get_Involved/documentation > > > 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 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 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 > > > > >
Re: Technical Writing / Updating Documentation
Hi Yury, I will read the following to get an understanding of the processes: https://community.kde.org/Get_Involved/documentation https://l10n.kde.org/docs/doc-primer/ Let me know if there's anything else I should be reading. Best, Aaron On Fri, Dec 23, 2022 at 7:15 AM Yuri Chornoivan 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 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 > > > > >
Re: Technical Writing / Updating Documentation
пʼятниця, 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 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
Re: Technical Writing / Updating Documentation
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 On Fri, Dec 23, 2022, 2:08 AM Yuri Chornoivan 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 > > > >
Re: Technical Writing / Updating Documentation
пʼятниця, 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
Technical Writing / Updating Documentation
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
