SoK/2025/StatusReport/Roopa Dharshini

Enhance KEcoLab Documentation and Create a Video Tutorial

Project Abstract

This project aims to improve the technical documentation for KEcoLab, a tool for measuring energy consumption in KDE applications. This includes enhancing existing documentation, creating new documentation on key aspects of the tool.

Deliverables

• Technical Documentation for the developers
• Non-technical Documentation for the users

Mentors

• Joseph P. De Veaugh-Geiss @joseph:kde.org
• Kieryn Darkwater (Video) @mxdarkwater:matrix.org
• Karanjot Singh @drquark:kde.org
• Aakarsh MJ @aakarshmj:matrix.org
• Pradyot Ranjan (Video) @pradyotranjan:gitter.im

Issues Created

• Outline for the documentation
• Usage Scenario Script for Users
• CI/CD Documentation for Developers
• Contribution Guidelines for Developers
• Access Results Page for Users
• User Guide Page

Final Documents

• User Guide documentation for KEcoLab Users
• Usage Scenario Script documentation
• Accessing result documentation for users
• CI/CD pipeline documentation for contributors
• Contribution guidelines

Blog

Preparing KEcoLab Technical Documentation in Season of KDE ‘25

Weekly Progress

Week 1

• Explored KECoLab Project's codebase, and it's working through a demo.
• Studied KECoLab's Handbook and existing documentation.
• Set up a GitLab Wiki in the forked repository.
• Discussed GitLab Wiki's Merge Request (MR) feature.

Week 2

• Created an outline for the entire technical documentation for KECoLab.
• Written usage scenario script for the users.
• Experimented with various methods of creating an MR for GitLab Wiki.
• Discussed with team members the default setting of the GitLab Wiki section.

Week 3

• Written CI/CD technical documentation for the developers.
• Gathered data on different documentation tools and discussed it with mentors.
• Discussed the KDE Community Wiki—disadvantages and advantages over GitLab Wiki.
• Mentors suggested changing the documentation's technical difficulty according to whether the reader is a user, developer, or contributor.

Week 4

• Created a ticket to sysadmin requesting approval for "Approved Revs" for KDE Community wiki pages.
• Set up a home page for KECoLab docs.
• Added the KECoLab Project under the Cross-origin section in the main page of the KDE Community Wiki.
• Written docs on technical part for the developers

Week 5-6

• Gone through KDE Community Wiki and found an interesting feature (protected page) to protect the page to avoid unnecessary edits in the document.
• Discussed the naming conventions of the documentation link for each page.
• Completed accessing the result document to clearly explain the process of generating reports and how to access it.
• Completed contribution guidelines documentation for the developers to start their contribution with the KEcoLab project.

Week 7-8

• Started writing a blog for the season of KDE 2025.
• Written a detailed user guide for the KEcoLab users
• Gathered screenshots for each step and added them to the documentation for better visual understanding for the readers.

Week 9-10

• Discussed the changes in the existing documentation.
• Finalized all the drafted documents and the blog.
• There were a lot of changes while migrating the drafted document since the KDE community wiki doesn't support markdown format.
• After doing the respective changes, I migrated all the drafted technical documentation from issues to KDE community wiki page.

Thank you!