Doc: Reorganize "Adding Docker Devices"

Task-number: QTCREATORBUG-29361
Change-Id: I1946c4667c4b5c27040988747ba4d25f0a429ed4
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>

doc/qtcreator/src/docker/creator-docker.qdoc

@@ -3,12 +3,13 @@
 
     /*!
     \page creator-adding-docker-devices.html
-    \previouspage creator-developing-b2qt.html
+    \previouspage creator-how-tos.html
-    \nextpage creator-developing-ios.html
 
-    \title Adding Docker Devices
+    \ingroup creator-how-to-docker
 
-    Create Docker devices from \l{ https://docs.docker.com/get-started/overview/}
+    \title Add Docker devices
+
+    Create Docker devices from \l{https://docs.docker.com/get-started/overview/}
     {Docker images} and use them to build, run, and debug applications. A Docker
     container operates like a virtual machine but uses less system resources at
     the cost of being less flexible.
@@ -16,7 +17,7 @@
     While Linux, \macos, and Windows hosts are supported in principle, Linux is
     the recommended platform.
 
-    To build, run, and debug applications on Docker devices, you must install and
+    To build, run, and debug applications on Docker devices, install and
     configure \c docker-cli on the development host. \QC automatically detects
     \l{kits-tab}{build and run kit} items, such \l{Add debuggers}
     {debuggers} and \l{Add Qt versions}{Qt versions}, in the Docker container
@@ -28,25 +29,61 @@
     \l{https://docs.docker.com/engine/reference/commandline/pull/}{docker pull}
     command.
 
-    \section1 Adding Docker Images as Devices
+    \section1 Add Docker images as devices
 
     To add a Docker image as a device:
 
     \list 1
-        \li Select \preferences > \uicontrol Devices
+        \li Go to \preferences > \uicontrol Devices > \uicontrol Docker.
-            > \uicontrol Docker and enter the path to the Docker CLI in
+        \li In \uicontrol Command, enter the path to the Docker CLI.
-            the \uicontrol Command field.
+            \image qtcreator-preferences-devices-docker.webp {Docker tab in Devices preferences}
-            \image qtcreator-preferences-devices-docker.webp "Docker tab in Devices preferences"
+        \li Go to \uicontrol Devices.
-        \li Select \uicontrol Devices > \uicontrol Add >
+        \li Select \uicontrol Add > \uicontrol {Docker Device} >
-            \uicontrol {Docker Device} > \uicontrol {Start Wizard}
+            \uicontrol {Start Wizard} to search for images in your
-            to search for images in your local Docker installation.
+            local Docker installation.
-        \li Select the Docker image to use, and then select \uicontrol OK.
+        \li Select a Docker image, and then select \uicontrol OK.
         \li In \uicontrol Devices, check and change Docker device preferences.
-            \image qtcreator-preferences-devices-docker-device.png "Docker device preferences"
+            \image qtcreator-preferences-devices-docker-device.png {Docker device preferences}
         \li Select \uicontrol Apply to save your changes.
     \endlist
 
-    The following table summarizes the options you can set.
+    \section2 Select Docker images
+
+    The \uicontrol {Docker Image Selection} dialog displays a list of Docker
+    images in your local Docker installation. You can sort the images according
+    to the repository name or tag or the image ID or size.
+
+    \image qtcreator-docker-image-selection.webp {Docker Image Selection dialog}
+
+    Select \uicontrol {Show unnamed images} to show images that are not tagged.
+
+    Double-click an image to select it.
+
+    \section1 Edit Docker device kits
+
+    Go to \preferences > \uicontrol Kits to check
+    that the automatically generated kits point to the appropriate kit items.
+
+    \sa {Docker}{How To: Develop for Docker}, {Manage Kits}{How To: Manage Kits}
+*/
+
+/*!
+    \page creator-preferences-docker.html
+    \previouspage creator-how-tos.html
+
+    \ingroup creator-how-to-docker
+
+    \title Set preferences for Docker devices
+
+    To set preferences for Docker devices:
+
+    \list 1
+        \li Go to \preferences > \uicontrol Devices > \uicontrol Devices.
+        \li In \uicontrol Device, select a Docker device.
+            \image qtcreator-preferences-devices-docker-device.png {Docker device preferences}
+    \endlist
+
+    The following table summarizes the preferences you can set.
 
     \table
     \header
@@ -59,7 +96,7 @@
             on Windows.
     \row
         \li \uicontrol {Do not modify entry point}
-        \li Stops \QC from modifying the \l {Modifying Entry Points}{entry point}
+        \li Stops \QC from modifying the \l {Modify entry points}{entry point}
             of the image. Make sure that the entry point starts a shell.
     \row
         \li \uicontrol {Enable flags needed for LLDB}
@@ -69,33 +106,18 @@
             \endcode
     \row
         \li \uicontrol {Clangd executable}
-        \li The path to a remote Clangd executable to use for a remote code
+        \li The path to a remote Clangd executable for a remote code model.
-            model.
     \row
         \li \uicontrol {Paths to mount}
-        \li Host directories to \l{Specifying Paths to Mount}{mount} into the
+        \li Host directories to \l{Specify paths to mount}{mount} into the
             container, such as the project directory.
     \row
         \li \uicontrol {Search locations}
-        \li Where to \l{Auto-detecting Kit Items}{automatically detect} kit
+        \li Where to \l{Auto-detect kit items}{automatically detect} kit
             items.
     \endtable
 
-    The following sections describe the Docker device preferences in more detail.
+    \section1 Modify entry points
-
-    \section2 Selecting Docker Images
-
-    The \uicontrol {Docker Image Selection} dialog displays a list of Docker
-    images in your local Docker installation. You can sort the images according
-    to the repository name or tag or the image ID or size.
-
-    \image qtcreator-docker-image-selection.webp "Docker Image Selection dialog"
-
-    Select \uicontrol {Show unnamed images} to show images that are not tagged.
-
-    Double-click an image to select it.
-
-    \section2 Modifying Entry Points
 
     The entry point of a Docker container is specified in the container settings
     and started as the main process when starting the container. The entry point
@@ -107,9 +129,9 @@
     \uicontrol {Do not modify entry point}. However, if the entry
     point you specify is not a shell, \QC cannot start the container.
 
-    \section2 Specifying Paths to Mount
+    \section1 Specify paths to mount
 
-    You can either copy your project files into the Docker container or specify
+    Copy your project files into the Docker container or specify
     paths to them in \uicontrol {Paths to mount}. Shared mounts are restricted
     to locations in the host system that can end up in the same absolute location
     in the Docker container. On Windows, network mounts cannot be used as shared
@@ -120,7 +142,7 @@
     \uicontrol {Delete Line} to delete the selected path or \uicontrol Clear
     to delete all paths.
 
-    \section2 Auto-detecting Kit Items
+    \section1 Auto-detect kit items
 
     Select \uicontrol {Auto-detect Kit Items} to find kit items and create kits
     for the Docker device. You can search for kit items in the device's PATH or
@@ -143,20 +165,28 @@
     \uicontrol {List Auto-Detected Kit Items}. To remove
     them, select \uicontrol {Remove Auto-Detected Kit Items}.
 
-    \section1 Editing Docker Device Kits
+    \sa {Docker}{How To: Develop for Docker}, {Manage Kits}{How To: Manage Kits}
+*/
 
-    Select \preferences > \uicontrol Kits to check
+/*!
-    that the automatically generated kits point to the appropriate kit items.
+    \page creator-how-to-build-run-docker.html
+    \previouspage creator-how-tos.html
 
-    To specify build settings:
+    \ingroup creator-how-to-docker
+
+    \title Build for and run on Docker devices
+
+    To specify build settings for Docker images:
 
         \list 1
             \li Open a project for an application you want to develop for the
                 device.
-            \li Select \uicontrol Projects > \uicontrol {Build & Run} to enable
+            \li Go to \uicontrol Projects > \uicontrol {Build & Run}, and
-                the kit that you specified above.
+                activate the kit for Docker devices.
         \endlist
 
     Select \uicontrol Run to specify run settings. Usually, you can use
     the default settings.
+
+    \sa {Docker}{How To: Develop for Docker}, {Manage Kits}{How To: Manage Kits}
 */

doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc

@@ -110,6 +110,13 @@
 
     \generatelist creator-how-to-b2qt
 
+    \section2 Docker
+
+    Create \e {Docker devices} from \e {Docker images} and use them to build,
+    run, and debug applications.
+
+    \generatelist creator-how-to-docker
+
     \section2 iOS
 
     Install \l {Qt for iOS} and Xcode, and connect iOS devices to the computer.

doc/qtcreator/src/linux-mobile/linuxdev.qdoc

@@ -49,7 +49,7 @@
     \image qtcreator-ssh-options.png {SSH preferences}
     //! [openssh]
 
-    \sa {Adding Docker Devices}, {Remote Linux}{How To: Develop for remote Linux},
+    \sa {Add Docker devices}, {Remote Linux}{How To: Develop for remote Linux},
     {Run in Qt Application Manager}, {Remote Linux Deploy Configuration},
     {Remote Linux Run Settings}
 */

doc/qtcreator/src/overview/creator-only/creator-mobile-targets.qdoc

@@ -44,7 +44,7 @@
             You can connect \B2Q devices to the development PC to run,
             debug, and analyze applications built for them from \QC.
 
-        \li \l {Adding Docker Devices}
+        \li \l {Add Docker images}
 
             Create Docker devices from Docker images and use them to build, run,
             and debug applications from \QC.

doc/qtcreator/src/projects/creator-only/creator-projects-building.qdoc

@@ -105,7 +105,7 @@
     \uicontrol Projects view.
 
     \sa {Configure projects for building}, {Build and Run}{How To: Build and Run},
-    {Adding Docker Devices}, {Specifying Build Settings}
+    {Add Docker devices}, {Specifying Build Settings}
 */
 
 /*!

doc/qtcreator/src/projects/creator-only/creator-projects-kits.qdoc

@@ -28,7 +28,7 @@
         \li \l{Developing for Android}{Android}
         \li \l{Developing for Bare Metal Devices}{Bare Metal}
         \li \l{\B2Q: Documentation}{\B2Q} (commercial only)
-        \li \l{Adding Docker Devices}{Docker} (experimental)
+        \li \l{Add Docker devices}{Docker} (experimental)
         \li \l{Developing for iOS}{iOS}
         \li iOS Simulator
         \li \l{Developing for MCUs}{MCU} (commercial only)

doc/qtcreator/src/projects/creator-only/creator-projects-settings-build.qdoc

@@ -57,7 +57,7 @@
     \section1 Build on remote devices
 
     You can build applications on \l{Developing for Remote Linux Devices}
-    {remote Linux} or \l{Adding Docker Devices}{Docker} devices if you
+    {remote Linux} or \l{Add Docker devices}{Docker} devices if you
     have kits that specify the devices and toolchains to use. When the
     build device of the kit is a remote device, such as a remote Linux or
     Docker device, the \uicontrol Browse button next to the

doc/qtcreator/src/qtcreator-toc.qdoc

@@ -24,7 +24,6 @@
             \li \l{Configuring Projects}
             \li \l{Connecting Devices}
             \list
-                \li \l{Adding Docker Devices}
                 \li \l{Building Applications for the Web}
             \endlist
             \li \l{Debugging}
@@ -58,6 +57,8 @@
                         \generatelist creator-how-to-bare-metal
                     \li \B2Q
                         \generatelist creator-how-to-b2qt
+                    \li Docker
+                        \generatelist creator-how-to-docker
                     \li iOS
                         \generatelist creator-how-to-ios
                     \li MCUs