SoK/Ideas/2017: Difference between revisions
mNo edit summary |
KApidox |
||
| Line 31: | Line 31: | ||
If you are not a developer but have a good idea for a proposal, get in contact with relevant developers first. | If you are not a developer but have a good idea for a proposal, get in contact with relevant developers first. | ||
=== Project: KApiDox and KDE Apis generations === | |||
Tool to create the api.kde.org website. It parses the KDE codebase, and runs doxygen in the right order, with the right parameters. | |||
It is part of the KDE Frameworks, and can be found in https://cgit.kde.org/kapidox.git ([email protected]:kapidox.git). | |||
More info on https://api.kde.org/frameworks/kapidox/html/ | |||
'''Brief explanation:''' The goal is to improve the codebase (refactoring, cleaning) and finish the integration of the .qch file generation. A following step would be to create a better entry point to each product: instead of a table of subproducts, allowing to have some explanation about the project, its organization and use, how to compile etc would make the documentation more useful (see Qt docs for examples) | |||
'''Expected results:''' A better documentation, more useful and that pull people to use our libraries ! | |||
'''Knowledge Prerequisite:''' Some Python, a lot of common sense, ability to understand the community's needs. | |||
'''Mentor:''' Olivier Churlaud (ochurlaud on Telegram and IRC but not often connected on the latter) <[email protected]> | |||
More about the needs can be found on my blog: | |||
* https://blogs.churlaud.com/somefoobar/2016/04/30/the-future-of-kapidox/ | |||
* https://blogs.churlaud.com/somefoobar/2016/06/11/kapidox-i-need-your-input/ | |||
* https://blogs.churlaud.com/somefoobar/2016/06/15/writing-up-to-date-tutorials-with-doxygen/ | |||
* https://blogs.churlaud.com/somefoobar/2016/07/16/the-kapidox-poll-results-at-last/ | |||
I'm available for talking more in details about the project on Telegram or by email (olivier AT churlaud DOT com or on the kde-devel mailing list) | |||
Revision as of 17:30, 1 October 2017
Ideas
Information for students
These ideas were contributed by our developers and users. They are sometimes vague or incomplete. If you wish to submit a proposal based on these ideas, contact the developers and find out more about the particular suggestion you're interested in.
When writing your proposal or asking for help from the general KDE community don't assume people are familiar with the ideas here. KDE is really big!
If there is no specific contact given in the idea, you can ask questions on the general KDE development list [email protected]. See the KDE mailing lists page for information on available mailing lists and how to subscribe.
Project: Sample project
Brief explanation:
Expected results:
Knowledge Prerequisite:
Mentor:
When adding an idea to this section, please try to include the following data:
- if the application is not widely known, a description of what it does and where its code lives
- a brief explanation
- the expected results
- pre-requisites for working on your project
- if applicable, links to more information or discussions
- mailing list or IRC channel for your application/library/module
- your name and email address for contact (if you're willing to be a mentor)
If you are not a developer but have a good idea for a proposal, get in contact with relevant developers first.
Project: KApiDox and KDE Apis generations
Tool to create the api.kde.org website. It parses the KDE codebase, and runs doxygen in the right order, with the right parameters. It is part of the KDE Frameworks, and can be found in https://cgit.kde.org/kapidox.git ([email protected]:kapidox.git).
More info on https://api.kde.org/frameworks/kapidox/html/
Brief explanation: The goal is to improve the codebase (refactoring, cleaning) and finish the integration of the .qch file generation. A following step would be to create a better entry point to each product: instead of a table of subproducts, allowing to have some explanation about the project, its organization and use, how to compile etc would make the documentation more useful (see Qt docs for examples)
Expected results: A better documentation, more useful and that pull people to use our libraries !
Knowledge Prerequisite: Some Python, a lot of common sense, ability to understand the community's needs.
Mentor: Olivier Churlaud (ochurlaud on Telegram and IRC but not often connected on the latter) <[email protected]>
More about the needs can be found on my blog:
- https://blogs.churlaud.com/somefoobar/2016/04/30/the-future-of-kapidox/
- https://blogs.churlaud.com/somefoobar/2016/06/11/kapidox-i-need-your-input/
- https://blogs.churlaud.com/somefoobar/2016/06/15/writing-up-to-date-tutorials-with-doxygen/
- https://blogs.churlaud.com/somefoobar/2016/07/16/the-kapidox-poll-results-at-last/
I'm available for talking more in details about the project on Telegram or by email (olivier AT churlaud DOT com or on the kde-devel mailing list)