Gardening/docwebsites: Difference between revisions

From KDE Community Wiki
(Add docwebsites love project objectives)
 
(Remove dead link to defunct ReviewBoard instance)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
== Gardening Day ==
== Gardening Day ==
One saturday in May 2015 we will hold a Gardening Day for documentation websites on #kde-devel
One Saturday in May 2015 we will hold a '''Gardening Day''' for documentation websites on #kde-devel


=== Practicalities ===
=== Practicalities ===
* Code is at ?
* We will be working on the master branches. The code repositories are at:
* We will be working on the master branch
** '''[https://ebn.kde.org/ English Breakfast Network]'''
** '''[https://invent.kde.org/websites/docs-kde-org KDE Invent]'''
 
* For patches:
* For patches:
** Smaller ones use http://paste.kde.org/ and seek approval in IRC
** Smaller ones use '''[https://invent.kde.org/dashboard/snippets Invent (GitLab) Snippets]''' and seek approval in IRC
** Bigger ones please use http://reviewboard.kde.org/
** Bigger ones, please use '''[https://phabricator.kde.org Phabricator]'''
* For bug triaging use the gardening field
 
* For bug triaging, use the gardening field
** + for really critical bugs that should be fixed as part of gardening
** + for really critical bugs that should be fixed as part of gardening
** ? for easy bugs
** ? for easy bugs
Line 23: Line 26:


== Done ==
== Done ==
== Important bugs that definitely need to be fixed before release ==
== Important bugs that definitely need to be fixed before release ==
== Bugs with patches that should be reviewed ==
== Bugs with patches that should be reviewed ==
== List of easy bugs that could be fixed as part of this love project ==
== List of easy bugs that could be fixed as part of this love project ==
 
== List of yet-to-be gardened bugs ==
== List of ungardened bugs ==

Latest revision as of 13:13, 5 July 2021

Gardening Day

One Saturday in May 2015 we will hold a Gardening Day for documentation websites on #kde-devel

Practicalities

  • For bug triaging, use the gardening field
    • + for really critical bugs that should be fixed as part of gardening
    • ? for easy bugs
    • - for out of scope (doesn't mean they are not important nor real, just that are not in scope for the gardening, i.e. they may be very corner case or need deep knowledge of the code base)

Objectives

  • Test/discover/file bugs against issues on api.kde.org, englishbreakfastnetwork.org and docs.kde.org
  • api.kde.org and englishbreakfastnetwork.org are not showing api for kf5 based applications and libraries or running kf5 based checks on kf5 based applications (and they are shown under KDE 4.latest which is incorrect). Thus the next 3 objectives.
  • Add kf5 based application and library apidocs to api.kde.org
  • Add kf5 based application and library code checks to ebn
  • Add kf5 based application and library documentation to docs.kde.org
  • Improve api.kde.org, ebn, and docs.kde.org to only update what has changed rather than everything (which takes up to 30 hours)
  • Create bug products for each of the above sites (or one product for websites with a subproject for each)

Done

Important bugs that definitely need to be fixed before release

Bugs with patches that should be reviewed

List of easy bugs that could be fixed as part of this love project

List of yet-to-be gardened bugs