SoK/2025/StatusReport/Roopa Dharshini: Difference between revisions
< SoK | 2025/StatusReport
Week 2 Status is updates |
Week 3 status is updates |
||
| Line 31: | Line 31: | ||
* Created an outline for the entire technical documentation for KECoLab. | * Created an outline for the entire technical documentation for KECoLab. | ||
* Written usage scenario script for the users. | * Written usage scenario script for the users. | ||
* Experimented with various methods of creating | * Experimented with various methods of creating an MR for GitLab Wiki. | ||
* Discussed with team members about the default setting of GitLab Wiki section. | * Discussed with team members about the default setting of the GitLab Wiki section. | ||
<h4>Week 3: </h4> | |||
* 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. | |||
Revision as of 16:03, 21 February 2025
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 Working on
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 about 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.