KDE Documentation/KDE Developer Guide
KDE Developer Guide
The KDE Developer Guide is a KDE_Documentation/KdeBooks KDE Books project initially written in 2011 as part of the Google Summer of Code program.
Current State of Developer Guide
As the guide was written in 2011, it does contain a lot of outdated information. Most of the changes required to update the guide consist of changing the URLs of dead links to new links. These changes generally fall into one of two categories: changing techbase.kde.org links to community.kde.org links, or finding new resources for dead links from external sources, notably Nokia's documentation for QT.
Known Issues
Please add any known issues in the current guide below.
Note: this list is by no means exhaustive. In particular, the Glossary section should be proof read by someone with a greater understanding of the KDE ecosystem.
General
- Update URLs to https.
- KDE4 is referenced throughout.
Section 3. How To Get Help
- Replace http://freenode.net/using_the_network.shtml with a new resource for access Freenode IRC.
Section 5. The QT Framework
- Replace http://doc.qt.nokia.com/ with a new resource for QT Tutorials (possibly QT Examples and Tutorials).
Section 6. Using git For KDE Development
- Update KDE Review Board link to Community Review Board link.
Section 7. Choosing An IDE
- Update KDevelop 4 to KDevelop 5.
Section 10. Prerequisites
- Link for information regarding environment variables (Environment Configuration) is dead and appears to not have an equivalent page in Community.
- All distribution specific build instructions have been removed and have no equivalent page on Community.
Section 11. Other Ways To Build The KDE SC
- Update Project Neon to KDE Neon equivalent.
- All OpenSuse links are dead.
Section 12. Scripted KDE Builds (kdesrc-build)
- Update mixed usage of SVN and git.
- Update https://projects.kde.org/ to https://cgit.kde.org or https://invent.kde.org when migration is complete.
- Update Subversion Repository link.
- Update kdesrc-build build requirements link, if still required.
- Update Running Your New KDE Installation section - most of this information appears to be outdated.
Section 13. Troubleshooting Your KDE Build
- Add matrix to IRC and Mailing List for more help.
Section 15. Useful Tools
- Add Valgrind to Debugging and Analysis Tools.
- Update QT Creator link (Nokia link 404s for obvious reasons).
Section 16. KDE Developer Guide Frequently Asked Questions (FAQ)
- Update Valgrind from TechBase to Valgrind. This can likely be removed entirely, as it is covered in Section 15. Useful Tools.
- Update Introduction to Bugzilla from TechBase to Community. Note: there is currently no Introduction to Bugzilla on Community - should this be created or link to an external resource?
- Update FAQ from TechBase to General FAQ.
Section 18. Useful Links
- Update KDE TechBase description to reflect it is for developers consuming KDE projects.
- Add KDE Community for developers working on KDE projects.
- Update QT Tutorials from Nokia to QT Company resources.
- Update Git in 30 Minutes as resource appears to be down.
- Consider removal of Behind KDE or updating it (hasn't been used since 2012).
- Update Planet KDE to use proper subdomain.
- Update TechBase Schedule to Community Schedule.