Jump to content

SoK/2025/StatusReport/Roopa Dharshini: Difference between revisions

From KDE Community Wiki
← Older edit
Rupa-rd (talk | contribs)
17 edits
Week 4 status is updated
Rupa-rd (talk | contribs)
17 edits
Updates week 5 and 6
 
Line 19: Line 19:
* [https://invent.kde.org/teams/eco/remote-eco-lab/-/issues/30 Usage Scenario Script for Users]
* [https://invent.kde.org/teams/eco/remote-eco-lab/-/issues/30 Usage Scenario Script for Users]
* [https://invent.kde.org/teams/eco/remote-eco-lab/-/issues/32 CI/CD Documentation for Developers]
* [https://invent.kde.org/teams/eco/remote-eco-lab/-/issues/32 CI/CD Documentation for Developers]
* [https://invent.kde.org/sdk/kecolab/-/issues/38 Contribution Guidelines for Developers]
* [https://invent.kde.org/sdk/kecolab/-/issues/37 Access Results Page for Users]
* [https://invent.kde.org/sdk/kecolab/-/issues/36 User Guide Page]


<h3>Weekly Progress</h3>
<h3>Weekly Progress</h3>


<h4>Week 1: </h4>
<h4>Week 1</h4>
* Explored KECoLab Project's codebase, and it's working through a demo.
* Explored KECoLab Project's codebase, and it's working through a demo.
* Studied KECoLab's Handbook and existing documentation.
* Studied KECoLab's Handbook and existing documentation.
Line 28: Line 31:
* Discussed GitLab Wiki's Merge Request (MR) feature.
* Discussed GitLab Wiki's Merge Request (MR) feature.


<h4>Week 2: </h4>
<h4>Week 2</h4>
* 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.
Line 34: Line 37:
* Discussed with team members the default setting of the GitLab Wiki section.
* Discussed with team members the default setting of the GitLab Wiki section.


<h4>Week 3: </h4>
<h4>Week 3</h4>
* Written CI/CD technical documentation for the developers.
* Written CI/CD technical documentation for the developers.
* Gathered data on different documentation tools and discussed it with mentors.
* Gathered data on different documentation tools and discussed it with mentors.
Line 40: Line 43:
* Mentors suggested changing the documentation's technical difficulty according to whether the reader is a user, developer, or contributor.
* Mentors suggested changing the documentation's technical difficulty according to whether the reader is a user, developer, or contributor.


<h4>Week 4: </h4>
<h4>Week 4</h4>
* Created a ticket to sysadmin requesting approval for "Approved Revs" for KDE Community wiki pages.
* Created a ticket to sysadmin requesting approval for "Approved Revs" for KDE Community wiki pages.
* Set up a home page for KECoLab docs.
* 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.
* 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
* Written docs on technical part for the developers
<h4>Week 5-6</h4>
* 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 KEcoLab project.

Latest revision as of 16:44, 21 March 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 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 KEcoLab project.
Retrieved from "https://community.kde.org/index.php?title=SoK/2025/StatusReport/Roopa_Dharshini&oldid=103062"