Wiki Team Page: Difference between revisions

Latest revision as of 09:53, 20 October 2022

UserBase problems

There is a list of problems with the wiki that we should like to have solved here: Wiki Team Page/Problems.

UserBase Wiki Team

Notes from the 2017 Akademy BOF BoF notes 2018

New welcome page! I have started it in my "personal" space - everyone can edit.
A new Introduction to new contributors - should be short and focus on the bare essentials; how to get an account, how to get in contact, a few things to avoid when editing existing pages, links to detailed info.
- The existing help pages needs cleanup and restructuring.

Use [[Category:New page]] at the bottom of any page that we are currently working on (wheather it is a new page or an old page under revision. When the work is done change [[Category:New page]] to [[Category:Good page]] (it won't be displayed on the actual page - it is just there to help us keep track of our work.

Slides from the documentation workshop at Akademy 2018: File:Tech writing-akademy18.odp

Plan of attack

Plasma pages - at least the general stuff.
Create pages for missing applications -- at least short description, logo, screenshot and links. Details can come later.
- GCompris
- Minuet
Existing application pages - make sure basic info is up to date, links working. Determine if content needs rewriting
Contributors pages
- Update an Image needs images

Needs attention at some point

~~Stats - most of the statistics no longer works.~~
- ~~<TopTenPages /> doesn't seem to be reckognized any more.~~
The Translate system behaves somewhat unpredictably.
- ~~The given number of translation units that needs attention is sometimes not correct~~
- In the translation interface (Special:Translate) when displaying differences the whole page is being shown rather than just the actual unit.
Some pages are not linked to: fx KDE_System_Administration
Some pages are probably not needed anymore:
- Tutorials/KDE3 to KDE SC 4
- Browser Configuration/Opera
- Browser Configuration
- Krita manuals ?
- Nepomuk
- KNode
- Kdenlive/Manual/Effects/Misc/keysplillm0pup
- KOffice, KWord, KCells, KChart, KFormula, KPlato, ... - Are the old KOffice apps completely dead now? - What about the tutorials - should they be adapted for Calligra Word?
- See alse Pages for Deletion
Some pages are badly in need of up to date information
- Plasma/Plasmoids
There are several references to Strigi, sRts, KControl, Kicker
~~The mediawiki installation: It is old - may need updating, which might solve other problems~~
Searching for users: the search box is not as useful as it might be - it finds everything including all translations
Searching for contributors and admins: The templates and DPL examples no longer work!
Application pages should not have version numbers in their name (like KAddressBook 4.4).
Go through settings pages to make sure everything is properly linked to.
Pages that need to be improved
- Dolphin/File Management
- Plasma application launchers
- Klipper/How_to_search_in_phone_books_using_Klipper
- Konversation/Configuring SASL authentication needs new images to match changes text

Needs to be added to/changed in help page

The new {{Emoji}} template

Pages that are not linked to

Accessibility (and pages linked from there)
Configure_your_desktop - this page should be updated or retired
QCA - probably belongs on TechBase or Community

Warning

Don't use the "what links here" wiki tool to check that a page is properly linked – it is no longer reliable!~~. Use the {{LinksTo|...}} template instead. Find this and other search tools here.~~

Admin

Cleanup of "dead" pages: Some pages have been deleted but left behind translated pages. They don't seem to linger in the translate system (needs to be confirmed). Do the translated units still exist? This involves several pages in the Kexi Manual.

Archive obsolete pages: UserBase contains some pages that are no longer relevant. They should be archived. We need to find out how to do this so that translations are archived with the original page rather than being left behind. In the mean time such pages should be marked by adding the template {{ObsoletePage}}. That will add a warning box to the page and place it in the Obsolete category.

Clean up categories

~~Make sure all (english) categories are listed in the Pages category in English~~.
Remove the category Terminology?
Special category for Manuals?
Move some categories from Pages to Pages in Turkish

@@ Line 1: / Line 1: @@
+== UserBase problems ==
+There is a list of problems with the wiki that we should like to have solved here: [[Wiki Team Page/Problems]].
 == UserBase Wiki Team ==
-[https://notes.kde.org/p/UserbaseWiki Notes] from the Akademy BOF
+[https://phabricator.kde.org/project/view/91/ KDE Documentation on Phabricator]
+[https://notes.kde.org/p/UserbaseWiki Notes] from the 2017 Akademy BOF [https://userbase.kde.org/User:Valoriez BoF notes] 2018
 * [[User:Claus chr/Welcome|New welcome page]]! I have started it in my "personal" space - everyone can edit.
 * A new [[Introduction to new contributors]] - should be short and focus on the bare essentials; how to get an account, how to get in contact, a few things to avoid when editing existing pages, links to detailed info.
 ** The existing help pages needs cleanup and restructuring.
@@ Line 10: / Line 15: @@
 Use <nowiki>[[Category:New page]]</nowiki> at the bottom of any page that we are currently working on (wheather it is a new page or an old page under revision. When the work is done change <nowiki>[[Category:New page]]</nowiki> to <nowiki>[[Category:Good page]]</nowiki> (it won't be displayed on the actual page - it is just there to help us keep track of our work.
-Plan of attack:
+Slides from the documentation workshop at Akademy 2018: [[File:Tech writing-akademy18.odp]]
+=== Plan of attack ===
 # Plasma pages - at least the general stuff.
 # Create pages for missing applications -- at least short description, logo, screenshot and links. Details can come later.
 #* [[GCompris]]
 #* [[Minuet]]
-#* [[Spectacle]]
 # Existing application pages - make sure basic info is up to date, links working. Determine if content needs rewriting
+# Contributors pages
+#* [[Update an Image]] needs images
+=== Needs attention at some point ===
+<strike>
+# [[Stats]] - most of the statistics no longer works.
+#* <code>{{Special:TranslationStats</code> produces what look like an image frame that can't find the associated image file. TranslationStats is part of the Translate extension ([https://www.mediawiki.org/wiki/Help:Extension:Translate/Statistics_and_reporting see more here]).
+#* <code><TopTenPages /></code> doesn't seem to be reckognized any more.</strike>
+# The Translate system behaves somewhat unpredictably. <strike>
+#* Pages that have been marked for translation does not always show up in the <tt>Special:LanguageStats</tt> page.
+#* The given number of translation units that needs attention is sometimes not correct</strike>
+#* In the translation interface (<tt>Special:Translate</tt>) when displaying differences the whole page is being shown rather than just the actual unit.
+# Some pages are not linked to: fx [[KDE_System_Administration]]
+# Some pages are probably not needed anymore:
+#* [[Tutorials/KDE3 to KDE SC 4]]
+#* [[Browser Configuration/Opera]]
+#* [[Browser Configuration]]
+#* Krita manuals ?
+#* [[Nepomuk]]
+#* [[KNode]]
+#* [[Kdenlive/Manual/Effects/Misc/keysplillm0pup]]
+#* [[KOffice]], [[KWord]], [[KCells]], [[KChart]], [[KFormula]], [[KPlato]], ... - Are the old KOffice apps completely dead now? - What about the tutorials - should they be adapted for Calligra Word?
+#* See alse [[Pages for Deletion]]
+# Some pages are badly in need of up to date information
+#* [[Plasma/Plasmoids]]
+# There are several references to Strigi, sRts, KControl, Kicker
+# <strike>The mediawiki installation: It is old - may need updating, which might solve other problems</strike>
+# Searching for users: the search box is not as useful as it might be - it finds everything including all translations
+# Searching for contributors and admins: The templates and DPL examples no longer work!
+# Application pages should not have version numbers in their name (like [[KAddressBook 4.4]]).
+# Go through settings pages to make sure everything is properly linked to.
+# Pages that need to be improved
+#* [[Dolphin/File Management]]
+#* [[Plasma application launchers]]
+#* [[Klipper/How_to_search_in_phone_books_using_Klipper]]
+#* [[Konversation/Configuring SASL authentication]] needs new images to match changes text
+=== Needs to be added to/changed in help page ===
+# The new <nowiki>{{Emoji}}</nowiki> template
+=== Pages that are not linked to ===
+# [[Accessibility]] (and pages linked from there)
+# [[Configure_your_desktop]] - this page should be updated or retired
+# [[QCA]] - probably belongs on TechBase or Community
+{{Warning|1=Don't use the "what links here" wiki tool to check that a page is properly linked &ndash; it is no longer reliable!<strike>. Use the <nowiki>{{LinksTo|...}}</nowiki> template instead. Find this and other search tools [[User:Claus chr/Search|here]].}}</strike>
+=== Admin ===
+;Cleanup of "dead" pages:
+:Some pages have been deleted but left behind translated pages. They don't seem to linger in the translate system (needs to be confirmed). Do the translated units still exist? This involves several pages in the Kexi Manual.
+;Archive obsolete pages:
+:UserBase contains some pages that are no longer relevant. They should be archived. We need to find out how to do this so that translations are archived with the original page rather than being left behind. In the mean time such pages should be marked by adding the template <nowiki>{{ObsoletePage}}</nowiki>. That will add a warning box to the page and place it in the Obsolete category.
+;Clean up categories
+* <del>Make sure all (english) categories are listed in the [https://userbase.kde.org/Category:Pages Pages category] in English</del>.
+* Remove the category Terminology?
+* Special category for Manuals?
+* Move some categories from Pages to Pages in Turkish
+[[Category:Admin]]