[Development] RFC: QUIP-21: Using images in Qt documentation

[Riitta-Leena Miettinen via Development]

Hello,

We've had guidelines for using images in the Qt Creator Manual for a long time 
(https://doc.qt.io/qtcreator-extending/qtcreator-documentation.html#using-images).
 To more consistently use images throughout the Qt documentation, the Qt 
Documentation Team would like to propose moving these instructions (as 
applicable) to a QUIP and then applying them to all Qt docs.

Please review https://codereview.qt-project.org/c/meta/quips/+/518011, and add 
your questions and concerns, or approval.

Cheers,

Leena


Leena Miettinen

Sr. Documentation Engineer

The Qt Company GmbH
Erich-Thilo-Str. 10
12489 Berlin, Germany

riitta-leena.mietti...@qt.io


www.qt.io

Geschäftsführer: Mika Pälsi, Juha Varelius, Jouni Lintunen Sitz der 
Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 144331 B

[https://www.qt.io/]
[https://www.facebook.com/qt/]
[https://twitter.com/qtproject]  
[https://www.linkedin.com/company/qtgroup/] 
 
[https://www.youtube.com/QtStudios] 
-- 
Development mailing list
Development@qt-project.org
https://lists.qt-project.org/listinfo/development

Re: [Development] Nominating Mats Honkamaa as an approver for the Qt Project

[Riitta-Leena Miettinen via Development]

+1

Leena


Leena Miettinen
Sr. Documentation Engineer
The Qt Company
Erich-Thilo-Str. 10 12489
Berlin, Germany
riitta-leena.mietti...@qt.io
www.qt.io
Geschäftsführer: Mika Pälsi, Juha Varelius, Jouni Lintunen Sitz der 
Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 144331 B
[cid:image001.png@01D92A95.3AEE9BF0]
[cid:image002.png@01D92A95.3AEE9BF0]
[cid:image003.png@01D92A95.3AEE9BF0]
[cid:image004.png@01D92A95.3AEE9BF0]
[cid:image005.png@01D92A95.3AEE9BF0]



Date: Tue, 17 Jan 2023 15:56:30 +
From: Mahmoud Ali 
To: "development@qt-project.org" 
Cc: Mats Honkamaa 
Subject: [Development] Nominating Mats Honkamaa as an approver for the
Qt Project
Message-ID:



Content-Type: text/plain; charset="us-ascii"

Hi all,

I'd like to nominate Mats Honkamaa as an approver for the Qt Project.

Mats has been working on Qt Studio Design Studio documentation and has 
regularly contributed to Qt Design Studio documentation.

Qt Commits:
   https://codereview.qt-project.org/q/owner:mats.honkamaa%2540qt.io

disclaimer: We work in the same team.


I trust him to be a good reviewer.


Kind regards,
Mahmoud Badri
Manager, R
The Qt Company
Tutkijantie 4C
FI-90590 Oulu
Finland
mahmoud.ba...@qt.io
+358 50 512 9535
www.qt.io

___
Development mailing list
Development@qt-project.org
https://lists.qt-project.org/listinfo/development

Re: [Development] Nominating Andreas Eliasson as Approver

[Riitta-Leena Miettinen]

+1

Leena


Date: Mon, 27 Jun 2022 07:31:39 +
From: Topi Reini? 
To: "Development@qt-project.org" 
Subject: Re: [Development] Nominating Andreas Eliasson as Approver
Message-ID:



Content-Type: text/plain; charset="utf-8"

+1

Andreas has proved himself to be a valuable contributor and reviewer of 
documentation changes across multiple modules, I'm confident he'd be a good 
approver.

Disclaimer: Andreas is a colleague of mine.

-Topi
--
Topi Reini?, Principal Documentation Engineer | The Qt Company

From: Development  on behalf of Kai K?hne 

Sent: Friday, June 24, 2022 5:07 PM
To: development@qt-project.org 
Subject: [Development] Nominating Andreas Eliasson as Approver

Hi,

I'd like to propose Andreas Eliasson as an Qt Project Approver.

Dashboard: https://codereview.qt-project.org/dashboard/1009951

Andreas started working on Qt documentation only in February. But since then, 
he did already quite some documentation related patches in various Qt modules. 
He has also been actively reviewing other people's documentation patches. So, I 
see little reason to wait much longer before making him an approver, also 
because getting another documentation approver would be handy in the upcoming 
vacation season?

Kai

--
Kai K?hne, Director R | The Qt Company

The Qt Company GmbH, Erich-Thilo-Str. 10, D-12489 Berlin
Gesch?ftsf?hrer: Mika P?lsi, Juha Varelius, Jouni Lintunen
Sitz der Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 
144331 B


___
Development mailing list
Development@qt-project.org
https://lists.qt-project.org/listinfo/development

Re: [Development] Avoiding ads and/or Google for doc searches

[Riitta-Leena Miettinen]

Date: Fri, 21 May 2021 17:22:13 +0200
From: Jason H 
To: Sze Howe Koh 
Cc: Qt development mailing list 
Subject: Re: [Development] Avoiding ads and/or Google for doc searches
(was: Changes to Freenode's IRC)

>And yes, I broke my own rule to not attribute to malice/greed what can be 
>explained by stupidity/laziness.

Hello Jason,

Might I suggest an even better rule? Do not attribute any characteristics to 
people whose motivations, skills, and working conditions you know absolutely 
nothing about.

You offhandedly managed to call all Qt Documentation Engineers stupid/lazy, 
when we in fact hated the adds and worked quite hard for a long time to have 
them turned off. That finally succeeded, and if you search for something now, 
you should not see any adds.

You are welcome,

Leena

---
Leena Miettinen
Sr. Documentation Engineer
The Qt Company
Erich-Thilo-Str. 10 12489
Berlin, Germany
riitta-leena.mietti...@qt.io
www.qt.io
Geschäftsführer: Mika Pälsi, Juha Varelius, Jouni Lintunen Sitz der 
Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 144331 B
[cid:image001.png@01D75189.0D2A3BC0]
[cid:image002.png@01D75189.0D2A3BC0]
[cid:image003.png@01D75189.0D2A3BC0]
[cid:image004.png@01D75189.0D2A3BC0]
[cid:image005.png@01D75189.0D2A3BC0]

___
Development mailing list
Development@qt-project.org
https://lists.qt-project.org/listinfo/development

Re: [Development] Nominating Johanna Vanhatapio as an approver

[Riitta-Leena Miettinen]

Date: Tue, 27 Apr 2021 18:38:01 +
From: Paul Wicking 
To: "development@qt-project.org" 
Subject: [Development] Nominating Johanna Vanhatapio as an approver

Hi all,

I'd like to nominate Johanna Vanhatapio as an approver.
Johanna has been working as a documentation engineer for the Qt Company
for over a year now, focusing on Qt Creator and Design Studio. She works
predominantly with creating both documentation and video tutorials (from
script to recording), and also participates actively in reviewing
documentation patches.

Commits:
https://codereview.qt-project.org/q/owner:johanna.vanhatapio%2540qt.io

Reviews:
https://codereview.qt-project.org/q/reviewer:johanna.vanhatapio%2540qt.io

--
Paul Wicking
R Manager

The Qt Company
Sandakerveien 116
0484, Oslo, Norway
paul.wick...@qt.io
+47 90 500 666
https://qt.io

The Future is Written with Qt
--

+1

Disclaimer: We work on the same project.

Cheers,

Leena

Leena Miettinen
Sr. Documentation Engineer
The Qt Company
Erich-Thilo-Str. 10 12489
Berlin, Germany
riitta-leena.mietti...@qt.io
www.qt.io
Geschäftsführer: Mika Pälsi, Juha Varelius, Jouni Lintunen Sitz der 
Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 144331 B
[cid:image001.png@01D73C18.5BB68950]
[cid:image002.png@01D73C18.5BB68950]
[cid:image003.png@01D73C18.5BB68950]
[cid:image004.png@01D73C18.5BB68950]
[cid:image005.png@01D73C18.5BB68950]



___
Development mailing list
Development@qt-project.org
https://lists.qt-project.org/listinfo/development

Re: [Development] Documenting Qt 6 API breakages

[Riitta-Leena Miettinen]

Hello,

How about using a similar approach to that used for documenting the CMake 
commands for each module in Qt 5.15?

That is:


  *   Create a qdoc file in each module that contains the breakages for that 
module and contains the \ingroup command migrate2qt6, or something like that.
  *   Create the \group page in the qtdoc module for central access to the 
information.

Cheers,

Leena


Leena Miettinen
Sr. Documentation Engineer

The Qt Company GmbH
Erich-Thilo-Str. 10
D-12489 Berlin
riitta-leena.mietti...@qt.io
http://qt.io

Geschäftsführer: Mika Pälsi, Juha Varelius, Mika Harjuaho
Sitz der Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 
144331 B


Date: Wed, 27 May 2020 14:48:57 +
From: Kai Köhne 
To: "development@qt-project.org" 
Subject: [Development] Documenting Qt 6 API breakages
Message-ID:



Content-Type: text/plain; charset="iso-8859-1"

Hi,

We should start documenting the API changes that Qt 6.0 brings soon. This will 
allow getting people getting an overview, help early adopters, and will give us 
time to improve the documentation before the release.

Now I see that there are different paths taken:
- Eskil and others have started listing changes in a page in the qtdoc 
repository, https://doc-snapshots.qt.io/qt6-dev/sourcebreaks.html
- I created a skeleton for Qt Core changes in the qtbase repository: 
https://codereview.qt-project.org/c/qt/qtbase/+/299664 .

I wasn't aware of the existing page in qtdoc; Anyhow, from past experience I 
prefer having the documentation nearby the actual code. I therefore would like 
move the existing sections about Qt Quick, Qt OpenGL to the respective module 
documentation and let https://doc-snapshots.qt.io/qt6-dev/sourcebreaks.html 
just link to the module documentation pages.

Thoughts?

Kai

--
Kai Köhne, Director R | The Qt Company

The Qt Company GmbH, Erich-Thilo-Straße 10, D-12489 Berlin
Geschäftsführer: Mika Pälsi, Juha Varelius, Mika Harjuaho
Sitz der Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 
144331 B



--

Subject: Digest Footer

___
Development mailing list
Development@qt-project.org
https://lists.qt-project.org/listinfo/development


--

End of Development Digest, Vol 104, Issue 63


___
Development mailing list
Development@qt-project.org
https://lists.qt-project.org/listinfo/development

Re: [Development] Assistant WebKit/WebEngine support

[Riitta-Leena Miettinen]

Yes, we never felt the styles should be exactly same, but the most suitable for 
each purpose.

Leena

Date: Wed, 26 Jun 2019 11:39:18 +
From: Christian Kandeler 
To: "development@qt-project.org" 
Subject: Re: [Development] Assistant WebKit/WebEngine support
Message-ID: <20190626133856.518e070a@ckandeler-archlinux>
Content-Type: text/plain; charset="utf-8"

On Wed, 26 Jun 2019 11:24:30 +0000
Riitta-Leena Miettinen  wrote:

>   3.  Should the same style be used online and offline?
>
> For 3), we always answered „yes“, because we felt that the use cases for 
> reading documentation on the web or using it within Qt Creator next to the 
> Code editor were different.

Just for clarification: I assume you meant "no" here?


Christian



___
Development mailing list
Development@qt-project.org
https://lists.qt-project.org/listinfo/development

Re: [Development] Assistant WebKit/WebEngine support

[Riitta-Leena Miettinen]

Hello all,

I think this thread is mixing at least three separate, if related issues:


  1.  What should be used for the help back end in Qt tools (Qt Creator and Qt 
Assistant)?
  2.  What should the documentation style look like?
  3.  Should the same style be used online and offline?

For 1), I would like to thank Konrad for the extensive list of options we have 
there. It would be good to put it in a JIRA task, so that it won’t get lost. We 
already have a task about looking into one of the options here: 
https://bugreports.qt.io/browse/QTBUG-74796

For 2), the doc team does not usually decide how the documentation style looks 
and that might be a good thing, because everybody has an opinion and they are 
all right, because it is an opinion . The style usually comes from a designer 
and we implement it as well as the HTML generated by QDoc lets us. We‘ve had 
lot of technical problems caused by the HTML generator that are stopping us 
from being flashy and modern, even though of course we’d like to.

For 3), we always answered „yes“, because we felt that the use cases for 
reading documentation on the web or using it within Qt Creator next to the Code 
editor were different. In the latter case, the white space was minimized, 
system font was used, and the text size was smaller to save space. Because QDoc 
separates Content from formatting, it is easily possible to generate 
documentation for different purposes from the same source if all the authors 
use QDoc commands consistently. The helps still looked nice, even they were 
different from the online version, until we had to start depending on 
QTextBrowser.

Thanks for the bug reports! To save everyone some time, please look around in 
JIRA for existing bugs first and report all style-related issues as QTBUGS. The 
styles come from Qt and only issues in the content of the Qt Creator Manual 
should be reported as a QTCREATORBUG. This is because the fixes will be done in 
Qt, not Qt Creator. I moved one of them here and reopened it, because after 
more study it looks like it might have been cause by a CSS change: 
https://bugreports.qt.io/browse/QTBUG-76705

So, when you report bugs, the more information you can include about what is 
wrong and when it changed, the more chance you’ll probably have of getting the 
bug fixed.

Cheers,

Leena

Date: Wed, 26 Jun 2019 10:09:24 +
From: "Palaraja, Kavindra" 
To: "development@qt-project.org" 
Subject: Re: [Development] Assistant WebKit/WebEngine support
Message-ID: <557ee263-e641-464f-b3b2-ac212c749...@luxoft.com>
Content-Type: text/plain; charset="utf-8"

Wow, I had no idea in my 12 years of being a Technical Writer that it's 
possible to annoy so many developers just by discussing a possibility of having 
better looking, higher quality documentation :)

On the other hand, as a former Troll who wrote the first version of Creator's 
manual (back when it was called Greenhouse) I'm actually slightly honored 
because so many developers are still so attached to how Qt's documentation 
looks in Creator.

Firstly -- the documentation isn't only used by you (anyone reading this 
e-mail). There are other people who use it too, like Designers or Technical 
Writers. A Designer would cringe at this content and we would lose them as a 
possible customer. There are also Managers and Architects who look at 
documentation to decide if they want to buy a Qt license.

Every day, a Technical Writer has two options -- fix content or fix the content 
experience. It's a daily battle. And if your team doesn't have a Content 
Strategist, an Information Architect, or a Site Designer, then these criteria 
are things that the Writer has to consider. So every time your Technical Writer 
spends time fighting to shrink an image, or find out why something doesn't 
render as expected, you're wasting their time. You might as well let the 
Technical Writer spend time on the content. That's the key -- as many of you 
have said -- you want to have the content there.

OK, you don't care how it looks -- I get it. But I care, as do many other 
people who may not be on this list, because it makes my content look bad. If 
the content looks better, you can write less. Imagine getting less walls of 
text to read. Maybe like Visual Studio Code's Release Notes -- there are GIFs 
here that show you the steps of how to use a feature, instead of writing those 
lines of "Select X, choose Y, Click Z."

https://code.visualstudio.com/updates/v1_35 -- They actually display this 
content in their IDE as well.

Seeing is believing. I apologize for not putting in a screenshot earlier. Here 
you go, here's the ugly table.

 vs. 
https://doc-snapshots.qt.io/qtapplicationmanager/manifest.html#

Here's the diagram that can't be scaled without ruining it's clarity. Yes, 
there are actually users who expect the diagrams to be sharp. If you have one 
of those newer monitors, the graininess is enough 

[Development] Subject: Re: Proposing CMake as build tool for Qt 6

[Riitta-Leena Miettinen]

Hello Kavindra,

There is a bug report about improving the Qt CMake documentation, where we are 
collecting ideas: https://bugreports.qt.io/browse/QTBUG-72159

Please add your questions and concerns there.

Cheers,

Leena


Date: Thu, 6 Jun 2019 14:08:56 +
From: "Palaraja, Kavindra" 
To: "development@qt-project.org" 
Subject: Re: [Development] Proposing CMake as build tool for Qt 6
Message-ID: <716bc4fd-5e4e-47d3-a8e1-b22ed3dec...@luxoft.com>
Content-Type: text/plain; charset="utf-8"

That's good to hear. I understand that there will be two levels of 
documentation:

- CMake itself on their side
- Qt's CMake related content; like the macros you mention

Regarding the possibly-internal bits, I would vote for having them documented 
still -- even if there's a note or a disclaimer explaining their status. This 
is a good way for your team to maintain the messaging; instead of having random 
blog posts circulating online about people's experiments on these internal 
macros. Those would then deviate from the official messaging. Additionally, I 
believe some of my colleagues, who are module maintainers outside of The Qt 
Company, could use this information.

Sure, I'll try to help with reviews when I have some time.

Thanks for your response,
Kavindra.

On 06.06.19, 16:00, "Kai Köhne"  wrote:



> -Original Message-
> From: Development  On Behalf Of
> Palaraja, Kavindra
> Sent: Thursday, June 6, 2019 3:38 PM
> To: development@qt-project.org
> Subject: Re: [Development] Proposing CMake as build tool for Qt 6
>
> Hi,
>
> Just curious, do you have a link to what the draft documentation for CMake
> looks like?

CMake has quite extensive documentation: 
https://cmake.org/cmake/help/latest/

> qmake's documentation has always been an afterthought. The documentation
> equivalent for CMake should be better than that – at the very least, it
> shouldn’t result in another https://wiki.qt.io/Undocumented_QMake and
> such.

I think this is the case  We're also gradually improving the documentation 
of CMake macros that Qt provides, see 
https://codereview.qt-project.org/q/topic:%22cmake_transition%22 (reviews 
welcome btw).

Now there will still be CMake macros & functions that are only used when 
building Qt itself (-> are internal). I don't think it makes sense yet to 
document them, because they're still in flux. But once things stabilize it 
would be IMO a good move to at least provide overview documentation.

Regards

Kai

___
Development mailing list
Development@qt-project.org
https://lists.qt-project.org/listinfo/development

Re: [Development] Build system for Qt 6

[Riitta-Leena Miettinen]

>Date: Wed, 31 Oct 2018 08:28:45 -0700
>From: Thiago Macieira 
>To: 
>Subject: Re: [Development] Build system for Qt 6
>Message-ID: <7867869.XuAOyZs5DA@tjmaciei-mobl1>
>Content-Type: text/plain; charset="iso-8859-1"
>
>>On Tuesday, 30 October 2018 22:59:57 PDT Andr? P?nitz wrote:
> >Where would a QBS-promoting webpage be located?
> >
> >qt-project.org ?
>
>Sure, why not?
>
>--
>Thiago Macieira - thiago.macieira (AT) intel.com
>  Software Architect - Intel Open Source Technology Center

Hello,

We actually have a separate domain for Qbs at qbs.io. Currently, it redirects 
to the Qbs Manual at doc.qt.io, but we were working on it:

https://bugreports.qt.io/browse/QBS-1341

Leena



___
Development mailing list
Development@qt-project.org
http://lists.qt-project.org/mailman/listinfo/development

Re: [Development] Nominating Vikas Pachdha for Approver status

[Riitta-Leena Miettinen]

+1

Leena

> -Original Message-
> From: Qt-creator [mailto:qt-creator-bounces+riitta-leena.miettinen=qt.io@qt-
> project.org] On Behalf Of Tobias Hunger
> Sent: Montag, 15. Mai 2017 10:56
> To: Eike Ziller ; 
> 
> Cc: qt-creator 
> Subject: Re: [Qt-creator] Nominating Vikas Pachdha for Approver status
> 
> +1 from my side. I have been reviewing Vikas patches since he started.
> 
> Best Regards,
> Tobias
> 
> --
> Tobias Hunger, Senior Software Engineer | The Qt Company
> The Qt Company GmbH, Rudower Chaussee 13, D-12489 Berlin
> Geschäftsführer: Mika Pälsi, Juha Varelius, Mika Harjuaho. Sitz der
> Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 144331
> B
> 
> 
> 
> From: Development  project.org> on behalf of Eike Ziller 
> Sent: Monday, May 15, 2017 10:43:57 AM
> To: 
> Cc: qt-creator
> Subject: [Development] Nominating Vikas Pachdha for Approver status
> 
> Hereby I nominate Vikas Pachdha for Approver status. He has been defacto
> maintaining iOS support in Qt Creator since a year.
> 
> https://codereview.qt-
> project.org/#/q/owner:%22Vikas+Pachdha%22+status:merged,n,z
> 
> Br,
> --
> Eike Ziller
> Principal Software Engineer
> 
> The Qt Company GmbH
> Rudower Chaussee 13
> D-12489 Berlin
> eike.zil...@qt.io
> http://qt.io
> Geschäftsführer: Mika Pälsi,
> Juha Varelius, Mika Harjuaho
> Sitz der Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, 
> HRB
> 144331 B
> 
> ___
> Development mailing list
> Development@qt-project.org
> http://lists.qt-project.org/mailman/listinfo/development
> ___
> Qt-creator mailing list
> qt-crea...@qt-project.org
> http://lists.qt-project.org/mailman/listinfo/qt-creator
___
Development mailing list
Development@qt-project.org
http://lists.qt-project.org/mailman/listinfo/development

Re: [Development] Request moving project (noron) to playground area

[Riitta-Leena Miettinen]

> Date: Fri, 24 Feb 2017 14:30:20 +
> From: "Stottlemyer, Brett (B.S.)" 
> To: Qt development mailing list 
> Subject: Re: [Development] Request moving project (noron) to
>   playground area
> Message-ID: <186aed03-a598-4668-a6d7-1686b796c...@ford.com>
> Content-Type: text/plain; charset="utf-8"
> 
> > On 2/24/17, 9:29 AM, "Andr? Hartmann" 
> wrote:
> >
> >Hi Brett,
> >
> >   Have a look at http://doc-snapshots.qt.io/
> 
> Didn?t even know that was there.
> 
> I was excited for a moment, but for some reason QtRO isn?t included in the
> TP section.
> http://doc-snapshots.qt.io/qt5-5.9/qtmodules.html#technology-preview-
> modules
> 
> What needs to happen to get QtRO added?  Again, the docs are part of the
> module.
> 

Hello Brett,

You could submit a patch that adds a link to the table that lists all Qt 
modules. There are some other tasks involved, too. Here is a link to a 
checklist for adding documentation for a new Qt module:

http://wiki.qt.io/Checklist_for_Adding_Documentation_for_a_New_Module

Leena


Leena Miettinen
Documentation Engineer

The Qt Company Germany GmbH
Rudower Chaussee 13
D-12489, Berlin, Germany
Geschäftsführer: Mika Pälsi, Juha Varelius, Mika Harjuaho 
Sitz der Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 
144331 B
riitta-leena.mietti...@qt.io
+49 30 63 92 3255
http://qt.io 










___
Development mailing list
Development@qt-project.org
http://lists.qt-project.org/mailman/listinfo/development