diff options
author | Robert Griebl <[email protected]> | 2022-07-29 23:18:37 +0200 |
---|---|---|
committer | Robert Griebl <[email protected]> | 2023-08-04 12:59:01 +0000 |
commit | b3665620377a06f7b7a012e2ae7b69d222fae435 (patch) | |
tree | 8a012e3ffd952197401f79a396e55e3850fee5ce /doc | |
parent | 7259d1a839a698e68bc4a7020a63d2aca79a5ec6 (diff) |
PLEASE NOTE: This project is not maintained anymore. It was ported to
a Qt 6 cmake setup and a more modern Django and Python version to at
least keep it usable for legacy projects.
For non-production use-cases, please switch to the new
appman-package-server available in the Qt Application Manager
starting with version 6.7.
Task-number: AUTOSUITE-1368
Change-Id: Idc4f2490a2a4399c03fce761250f4b5ac2612a45
Reviewed-by: Dominik Holland <[email protected]>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/QtAutoDeploymentServerDoc | 3 | ||||
-rw-r--r-- | doc/qtautodeploymentserver-project.qdocconf | 13 | ||||
-rw-r--r-- | doc/src/deployment-server-http-server-setup.qdoc | 5 | ||||
-rw-r--r-- | doc/src/deployment-server-installation.qdoc | 14 | ||||
-rw-r--r-- | doc/src/deployment-server-package-upload.qdoc | 6 | ||||
-rw-r--r-- | doc/src/deployment-server-reference.qdoc | 4 | ||||
-rw-r--r-- | doc/src/deployment-server.qdoc | 10 |
7 files changed, 39 insertions, 16 deletions
diff --git a/doc/QtAutoDeploymentServerDoc b/doc/QtAutoDeploymentServerDoc new file mode 100644 index 0000000..1c92d7c --- /dev/null +++ b/doc/QtAutoDeploymentServerDoc @@ -0,0 +1,3 @@ +// needed for the new clang based qdoc parser in Qt 5.11 +#include <QtAppManMain/QtAppManMain> +#include <QtCore/QtCore> diff --git a/doc/qtautodeploymentserver-project.qdocconf b/doc/qtautodeploymentserver-project.qdocconf index 258ef99..d310e7a 100644 --- a/doc/qtautodeploymentserver-project.qdocconf +++ b/doc/qtautodeploymentserver-project.qdocconf @@ -3,9 +3,14 @@ description = Qt Automotive Suite Deployment Server Documentat version = $QT_VERSION url = https://doc.qt.io/QtAutoDeploymentServer +# needed for the new clang based qdoc parser +moduleheader = QtAutoDeploymentServerDoc +includepaths = -I. + sourcedirs += src imagedirs += src/images +depends += qtcore qtapplicationmanager qhp.projects = QtAutoDeploymentServer qhp.QtAutoDeploymentServer.file = qtautodeploymentserver.qhp @@ -20,8 +25,8 @@ qhp.QtAutoDeploymentServer.customFilters.Qt.filterAttributes = qtautodeployments tagfile = qtautodeploymentserver.tags -depends = qtautomotivesuite - -buildversion = "Qt Automotive Suite Deployment Server $QT_VERSION" -navigation.homepage = "Qt Automotive Suite" navigation.landingpage = "Qt Automotive Suite Deployment Server" +buildversion = "Qt Automotive Suite Deployment Server $QT_VERSION" + +# Fail the documentation build if there are more warnings than the limit +warninglimit = 0 diff --git a/doc/src/deployment-server-http-server-setup.qdoc b/doc/src/deployment-server-http-server-setup.qdoc index b21ee76..d31b72c 100644 --- a/doc/src/deployment-server-http-server-setup.qdoc +++ b/doc/src/deployment-server-http-server-setup.qdoc @@ -27,13 +27,12 @@ ****************************************************************************/ /*! - \page qtauto-deployment-server-http-server-setup.html + \ingroup qtauto-deployment-server + \page http-server-setup.html \previouspage Qt Automotive Suite Deployment Server API Reference \nextpage Upload Packages to the Deployment Server - \contentspage {Qt Automotive Suite Deployment Server} \startpage Qt Automotive Suite Deployment Server - \title Set up a Production server with Apache, Lighttpd or Nginx The Deployment Server can be set up in combination with a regular web server: Apache, Lighttpd, or diff --git a/doc/src/deployment-server-installation.qdoc b/doc/src/deployment-server-installation.qdoc index 7937992..06fb895 100644 --- a/doc/src/deployment-server-installation.qdoc +++ b/doc/src/deployment-server-installation.qdoc @@ -27,14 +27,24 @@ ****************************************************************************/ /*! - \page qtauto-deployment-server-installation.html - \contentspage {Qt Automotive Suite Deployment Server} + \ingroup qtauto-deployment-server + \page installation.html \previouspage Qt Automotive Suite Deployment Server \nextpage Qt Automotive Suite Deployment Server API Reference \startpage Qt Automotive Suite Deployment Server \title Qt Automotive Suite Deployment Server Installation + \section1 Set up the Server in a Docker Container + + The new recommended way to run this server is through the supplied \c Dockerfile and the + \c docker-manage.sh script, which can both be found in the modules root directory. + + Instead of messing with Django's project configuration, you can simply export your individual + settings as environment variables. Either directly in the \c Dockerfile when building the + container, or by copying and modifying the \c docker-manage.sh script. + + \section1 Set up the Server in a Virtual Environment Before you install the dependencies in the Python virtual environment, you need to install the diff --git a/doc/src/deployment-server-package-upload.qdoc b/doc/src/deployment-server-package-upload.qdoc index dc5b7b4..f2e09de 100644 --- a/doc/src/deployment-server-package-upload.qdoc +++ b/doc/src/deployment-server-package-upload.qdoc @@ -27,10 +27,10 @@ ****************************************************************************/ /*! - \page qtauto-deployment-server-package-upload.html + \ingroup qtauto-deployment-server + \page package-upload.html \previouspage Set up a Production server with Apache, Lighttpd or Nginx \nextpage Qt Automotive Suite Deployment Server - \contentspage {Qt Automotive Suite Deployment Server} \startpage Qt Automotive Suite Deployment Server @@ -43,7 +43,7 @@ server itself. \section1 Through Server Admin Page This was the first uploading method implemented. It uses django admin page, accessible by \c{/admin/} URL of -the Deployment Server. For Qt 5.14, the URL is \l{http://demoappsdeploy.qt.io:8514/admin/}. +the Deployment Server. To add application: \list diff --git a/doc/src/deployment-server-reference.qdoc b/doc/src/deployment-server-reference.qdoc index d4be3af..6036e67 100644 --- a/doc/src/deployment-server-reference.qdoc +++ b/doc/src/deployment-server-reference.qdoc @@ -27,10 +27,10 @@ ****************************************************************************/ /*! - \page qtauto-deployment-server-reference.html + \ingroup qtauto-deployment-server + \page reference.html \previouspage Qt Automotive Suite Deployment Server Installation \nextpage Set up a Production server with Apache, Lighttpd or Nginx - \contentspage {Qt Automotive Suite Deployment Server} \startpage Qt Automotive Suite Deployment Server \title Qt Automotive Suite Deployment Server API Reference diff --git a/doc/src/deployment-server.qdoc b/doc/src/deployment-server.qdoc index 50f2bee..9c6390c 100644 --- a/doc/src/deployment-server.qdoc +++ b/doc/src/deployment-server.qdoc @@ -27,13 +27,19 @@ ****************************************************************************/ /*! - \page qtauto-deployment-server-index.html - \contentspage {Qt Automotive Suite} + \ingroup qtauto-deployment-server + \page index.html \nextpage Qt Automotive Suite Deployment Server Installation \startpage Qt Automotive Suite Deployment Server \title Qt Automotive Suite Deployment Server + \note This project is not maintained anymore. It was ported to a Qt 6 cmake setup and a more + modern Django and Python version to at least keep it usable for legacy projects. + For non-production use-cases, please switch to the new + \l{Package-Server}{appman-package-server} + available in the \l{Qt Application Manager} starting with version 6.7. + The Qt Automotive Suite Deployment Server is a new component in the Qt Automotive Suite 5.12. Previously, it was known as the Neptune Appstore and used for demonstrations purposes. |