Category:Developing Qt::Documentation: Difference between revisions
| Line 7: | Line 7: | ||
The documents in this category aim to cover the many aspects of Qt documentation creation, including the process we use to accept contributions from other community members. | The documents in this category aim to cover the many aspects of Qt documentation creation, including the process we use to accept contributions from other community members. | ||
== Documentation Snapshots == | ==Documentation Snapshots== | ||
Currently, Qt documentation is hosted at three sites: | Currently, Qt documentation is hosted at three sites: | ||
*[http://doc.qt.io/ doc.qt.io]: contains official releases | |||
*[http://doc-snapshots.qt.io/ snapshots]: contains unreleased documentation from the [http://codereview.qt-project.org/ Codereview] repositories | |||
*[http://doc.qt.io/archives/ archives]: contains legacy documentation | |||
=== Prerequisites === | ==Contributing to Qt Documentation== | ||
===Prerequisites=== | |||
Here are the basic steps to help you get started contributing to the Qt documentation: | Here are the basic steps to help you get started contributing to the Qt documentation: | ||
=== Style and Language Guidelines === | #Familiarize yourself with the [[:Category:Developing_Qt | development process]]. In particular, [[Qt Contribution Guidelines | the process of contributing code]]. | ||
#Create a [https://bugreports.qt.io Jira] account and set up your [[Setting up Gerrit | Gerrit]] environment. | |||
#[[Get_The_Source | Download]] the Qt sources. | |||
#Read the page regarding [[Code_Reviews | code reviews]]. | |||
===Style and Language Guidelines=== | |||
Qt documentation adheres to the [https://docs.microsoft.com/en-us/style-guide/welcome/ Microsoft Style Guide]. The documentation follows American English grammar and spelling. | Qt documentation adheres to the [https://docs.microsoft.com/en-us/style-guide/welcome/ Microsoft Style Guide]. The documentation follows American English grammar and spelling. | ||
The [[Language_Guidelines | Language Guidelines]] page provides further information about idioms and usage, punctuation and grammar issues. | The [[Language_Guidelines | Language Guidelines]] page provides further information about idioms and usage, punctuation and grammar issues. | ||
=== QDoc === | ===QDoc=== | ||
Qt's documentation tool is QDoc. QDoc scans through the source and generates html pages regarding the classes, enums, QML types, and other parts of the | Qt's documentation tool is QDoc. QDoc scans through the source and generates html pages regarding the classes, enums, QML types, and other parts of the | ||
reference documentation. | reference documentation. | ||
* [http://doc-snapshots.qt.io/qt5-dev/qdoc-index.html QDoc Manual] | *[http://doc-snapshots.qt.io/qt5-dev/qdoc-index.html QDoc Manual] | ||
To get started, the [http://doc.qt.io/qt-5/qdoc-guide.html QDoc Guide] explains how QDoc generates documentation from QDoc comments. | To get started, the [http://doc.qt.io/qt-5/qdoc-guide.html QDoc Guide] explains how QDoc generates documentation from QDoc comments. | ||
=== QDoc Regression Testing === | ===QDoc Regression Testing=== | ||
* [[QDocRegressionTesting]] | *[[QDocRegressionTesting]] | ||
=== [[:Category:Writing Guidelines]] === | ===[[:Category:Writing Guidelines]]=== | ||
* [[Qt Writing Guidelines]] | *[[Qt Writing Guidelines]] | ||
=== Submitting a Patch === | ===Submitting a Patch=== | ||
The process for submitting a documentation patch is the same as for source code. For more information, read the [[Code_Reviews | Code Reviews ]] page. | The process for submitting a documentation patch is the same as for source code. For more information, read the [[Code_Reviews | Code Reviews]] page. | ||
==== Approvers and Editors ==== | ====Approvers and Editors==== | ||
For language reviews, documentation reviews, and technical reviews, you may add any of the relevant [[Maintainers | maintainers]] as reviewers as well as the following individuals: | For language reviews, documentation reviews, and technical reviews, you may add any of the relevant [[Maintainers | maintainers]] as reviewers as well as the following individuals: | ||
* [[User:Andreaseliasson|Andreas Eliasson]] | *[[User:Andreaseliasson|Andreas Eliasson]] | ||
* [[User:Jaishreevyas|Jaishree Vyas]] (Qt Foundations) | *[[User:Jaishreevyas|Jaishree Vyas]] (Qt Foundations) | ||
* [[User:Johannavanhatapio|Johanna Vanhatapio]] (Qt Design Studio) | *[[User:Johannavanhatapio|Johanna Vanhatapio]] (Qt Design Studio) | ||
* [[User:Leenamiettinen|Leena Miettinen]] (Qt Creator documentation maintainer) | *[[User:Leenamiettinen|Leena Miettinen]] (Qt Creator documentation maintainer) | ||
* [[User:Lucadisera|Luca Di Sera]] | *[[User:Lucadisera|Luca Di Sera]] | ||
* [[User:Matshonkamaa|Mats Honkamaa]] (Qt Design Studio) | *[[User:Matshonkamaa|Mats Honkamaa]] (Qt Design Studio) | ||
* [[User:Nicholasbennet|Nicholas Bennet]] (Platform documentation) | *[[User:Nicholasbennet|Nicholas Bennet]] (Platform documentation) | ||
* [[User:Paulwicking|Paul Wicking]] | *[[User:Paulwicking|Paul Wicking]] | ||
* [[User:Topireinio|Topi Reiniö]] (QDoc maintainer) | *[[User:Topireinio|Topi Reiniö]] (QDoc maintainer) | ||
* [[User:Venugopalshivashankar|Venugopal Shivashankar]] | *[[User:Venugopalshivashankar|Venugopal Shivashankar]] | ||
* [[User:Szehowekoh|Sze Howe Koh]] | *[[User:Szehowekoh|Sze Howe Koh]] | ||
For language reviews (particularly for non-native English speakers) only, you may also add any of the following individuals: | For language reviews (particularly for non-native English speakers) only, you may also add any of the following individuals: | ||
* Mitch Curtis | |||
* Lorn Potter | *Mitch Curtis | ||
* [[User:EdwardWelbourne|Edward Welbourne]] | *Lorn Potter | ||
*[[User:EdwardWelbourne|Edward Welbourne]] | |||
For documentation help, join the #qt-documentation channel in Freenode. | For documentation help, join the #qt-documentation channel in Freenode. | ||
=== Filing Documentation Issues === | ===Filing Documentation Issues=== | ||
Anybody with a [https://bugreports.qt.io/ Jira] account may file a bug. For documentation bugs, please file the issue and enter ''Documentation'' '''AND''' the relevant library or module in the Component field. The process of fixing code bugs also apply to documentation issues. | Anybody with a [https://bugreports.qt.io/ Jira] account may file a bug. For documentation bugs, please file the issue and enter ''Documentation'' '''AND''' the relevant library or module in the Component field. The process of fixing code bugs also apply to documentation issues. | ||
Before filing an issue, please check that it has not already been fixed in a later version of the documentation. | Before filing an issue, please check that it has not already been fixed in a later version of the documentation. | ||
The latest documentation snapshots are at [http://doc-snapshots.qt.io/ | The latest documentation snapshots are at [http://doc-snapshots.qt.io/ doc-snapshots.qt.io] | ||
== Qt Documentation == | ==Modular Qt Documentation== | ||
The organization and development of modular Qt documentation is covered in another wiki: [[Qt5DocumentationProject]] | The organization and development of modular Qt documentation is covered in another wiki: [[Qt5DocumentationProject]] | ||
=== Documentation Structure === | ===Documentation Structure=== | ||
The [[Qt_Documentation_Structure | Qt Documentation Structure]] page provides information about the structure of the documentation. | The [[Qt_Documentation_Structure | Qt Documentation Structure]] page provides information about the structure of the documentation. | ||
Revision as of 08:43, 4 March 2022
Qt documentation is written by a small global team of technical writers and developers working at The Qt Company, complemented by a number of contributors from other parts of the Qt community. Since different parts of Qt are developed in different locations, writers with expertize in a particular area are typically co-located with the developers of that area. For example, the documentation for Qt Creator is written in Berlin.
Qt's technical writers are also responsible for many of the examples provided with Qt and related projects. However, the demonstrations provided with these projects are typically created by developers, and these are often not intended to be documented or supported by the Qt documentation team.
The documents in this category aim to cover the many aspects of Qt documentation creation, including the process we use to accept contributions from other community members.
Documentation Snapshots
Currently, Qt documentation is hosted at three sites:
- doc.qt.io: contains official releases
- snapshots: contains unreleased documentation from the Codereview repositories
- archives: contains legacy documentation
Contributing to Qt Documentation
Prerequisites
Here are the basic steps to help you get started contributing to the Qt documentation:
- Familiarize yourself with the development process. In particular, the process of contributing code.
- Create a Jira account and set up your Gerrit environment.
- Download the Qt sources.
- Read the page regarding code reviews.
Style and Language Guidelines
Qt documentation adheres to the Microsoft Style Guide. The documentation follows American English grammar and spelling.
The Language Guidelines page provides further information about idioms and usage, punctuation and grammar issues.
QDoc
Qt's documentation tool is QDoc. QDoc scans through the source and generates html pages regarding the classes, enums, QML types, and other parts of the reference documentation.
To get started, the QDoc Guide explains how QDoc generates documentation from QDoc comments.
QDoc Regression Testing
Category:Writing Guidelines
Submitting a Patch
The process for submitting a documentation patch is the same as for source code. For more information, read the Code Reviews page.
Approvers and Editors
For language reviews, documentation reviews, and technical reviews, you may add any of the relevant maintainers as reviewers as well as the following individuals:
- Andreas Eliasson
- Jaishree Vyas (Qt Foundations)
- Johanna Vanhatapio (Qt Design Studio)
- Leena Miettinen (Qt Creator documentation maintainer)
- Luca Di Sera
- Mats Honkamaa (Qt Design Studio)
- Nicholas Bennet (Platform documentation)
- Paul Wicking
- Topi Reiniö (QDoc maintainer)
- Venugopal Shivashankar
- Sze Howe Koh
For language reviews (particularly for non-native English speakers) only, you may also add any of the following individuals:
- Mitch Curtis
- Lorn Potter
- Edward Welbourne
For documentation help, join the #qt-documentation channel in Freenode.
Filing Documentation Issues
Anybody with a Jira account may file a bug. For documentation bugs, please file the issue and enter Documentation AND the relevant library or module in the Component field. The process of fixing code bugs also apply to documentation issues.
Before filing an issue, please check that it has not already been fixed in a later version of the documentation. The latest documentation snapshots are at doc-snapshots.qt.io
Modular Qt Documentation
The organization and development of modular Qt documentation is covered in another wiki: Qt5DocumentationProject
Documentation Structure
The Qt Documentation Structure page provides information about the structure of the documentation.
Pages in category "Developing Qt::Documentation"
The following 5 pages are in this category, out of 5 total.