On 23.09.2013, at 16:45, Guido Seifert <[email protected]> wrote: > >>> My idea is to create a series of questions and answers on StackOverflow. >>> The advantage: Everyone can participate. Add comments, correct my mistakes. >>> It is easier to find. SO ranks stellar in Google. >> >> Unfortunately that means that probably wrong, outdated and unreviewed >> documentation on how to do things in Qt Creator would rank >> stellar in Google. Which I'd claim would be a bad thing, maybe even worse >> than no documentation. > > And this is where the 'everyone can participate' comes in. When I edit the > post ten times, or if five different people edit it, it goes automatically > into the SO community wiki. This means almost everyone can edit it, add to it > and correct mistakes. My hope is, that exactly this will happen. Sure, some > pdf somewhere is constantly outdated. The docs, which come with QtC... erm... > sorry, but for most people, who just want to fix a bug in the docs,
They can't fix bugs in the docs through SO, since the docs (user & dev) are in the Qt Creator repository ;) > or add a comment about something new, the gerrit stuff is quite a hurdle. In > doubt they just go away, when they see the 'how to create a gerrit account' > page. This is nothing you do when you just want to add something between two > compiler runs. Unfortunately gerrit is a legal requirement for us for including anything (non-trivial) in the Qt Creator repository. Btw, we also already have the forums on qt-project.org (some of the core developers visit that once in a while), and the wikis there too (these have the same problem contribution-wise though). I don't believe that opening up yet another channel is a good move. Anyhow, at least I will probably not invest time into something that can never be integrated into "upstream" Qt Creator. >> Btw, that vcreatelogic document even was wrong for QtC 1 for which it was >> written (in subtle ways, meaning that the >> code seemed to work but actually didn't really), exactly because it was >> never reviewed by someone who knows their >> stuff around Qt Creator. > > It didn't? Strange, I was able to get all examples to work. Ok, I did not > bother with the ftp stuff, this required some 3rd party code. > The search stuff was a tough nut and no fun to figure out. But still, it > would have been even harder without this document. What was it that seemed to > work, but did not? It starts with wrong values in the compatVersion of the plugin spec, continues with connecting slots to cmd->action() instead of the plugin's registered QAction (and setting cmd->action()->setText), and doesn't stop there. All of this seems to work, but it doesn't use the concepts right, and it will bite you in "real" life at some later point. >> I would greatly appreciate contributions to the documentation in the Qt >> Creator repository, i.e. what Leena pointed you to. > > Yes, yes... I am currently very close to a release of one of my software > projects and don't have too much time, but I think can add > a bit to the official docs, too. :-) That would be fantastic. Good luck with your release. Br, Eike > > Guido > >> Br, Eike >> >>> Here is one example, how I think it could be done: >>> http://stackoverflow.com/questions/18633006/how-do-i-add-my-own-options-page-to-the-qtcreator >>> >>> Any comments? Ideas? Help offers? Curses? >>> >>> Guido >>> _______________________________________________ >>> Qt-creator mailing list >>> [email protected] >>> http://lists.qt-project.org/mailman/listinfo/qt-creator >> >> -- >> Eike Ziller, Senior Software Engineer - Digia, Qt >> >> Digia Germany GmbH, Rudower Chaussee 13, D-12489 Berlin >> Geschäftsführer: Mika Pälsi, Juha Varelius, Anja Wasenius >> Sitz der Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, >> HRB 144331 B >> -- Eike Ziller, Senior Software Engineer - Digia, Qt Digia Germany GmbH, Rudower Chaussee 13, D-12489 Berlin Geschäftsführer: Mika Pälsi, Juha Varelius, Anja Wasenius Sitz der Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 144331 B _______________________________________________ Qt-creator mailing list [email protected] http://lists.qt-project.org/mailman/listinfo/qt-creator
