Contributing to Qt Documentation: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
(Created page with "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 expertise in a particular area are typically co-located with the developers of that area. Qt's technical writers are also responsible for many of the examples provided with Qt and related projects. Howe...")
 
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
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 expertise in a particular area are typically co-located with the developers of that area.
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 expertise in a particular area are typically co-located with the developers of that area.
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==
==Documentation Snapshots==
Currently, Qt documentation is hosted online at:
Currently, Qt documentation is hosted online at:
Line 10: Line 6:
*[http://doc.qt.io/archives/ archives]: contains legacy documentation
*[http://doc.qt.io/archives/ archives]: contains legacy documentation
Also, when installing a version of Qt and Qt Creator, an offline documentation set of that particular release is included.
Also, when installing a version of Qt and Qt Creator, an offline documentation set of that particular release is included.
==Setting Up for Documentation Writing==
Here are the basic steps to help you get started contributing to the Qt documentation:
#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]].
#Start by contributing small fixes. Don't hesitate to ask for help!
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. It is possible to create a documentation set for Qt modules and tools.
*[http://doc-snapshots.qt.io/qt6-dev/qdoc-index.html QDoc Manual]
*[[QDocRegressionTesting]] - how to test the Qt documentation set
*[[Building Qt Documentation]]
==Writing Guidelines==
The Qt Writing Guidelines can with creating and editing Qt documentation. We adhere to it for consistency and to create a singular voice. We also follow the QUIP system and follow the requirements regarding examples and images.
*[[Qt Writing Guidelines]]
==Getting Help with Editing==
The process for submitting a documentation patch is the same as for source code. For more information, read the [[ Code Reviews]] page.


== Getting Help with Editing ==
For documentation reviews, you may add the following for reviews:
For documentation reviews, you may add the following for reviews:
====Qt Oslo - Qt Reference Documentation and QDoc:====
====Qt Oslo - Qt Reference Documentation and QDoc:====
Line 48: Line 29:
*Pranta Dastider (Qt Design Studio  documentation)
*Pranta Dastider (Qt Design Studio  documentation)
*Teea Põldsam (Qt Design Studio and Qt License Server documentation)
*Teea Põldsam (Qt Design Studio and Qt License Server documentation)
*
 
 
Also, the following people can help with English and technical reviews:
Also, the following people can help with English and technical reviews:
*Mitch Curtis
*Mitch Curtis
Line 54: Line 36:
*[[User:EdwardWelbourne|Edward Welbourne]]
*[[User:EdwardWelbourne|Edward Welbourne]]
*[[User:JKSH|Sze Howe Koh]]
*[[User:JKSH|Sze Howe Koh]]
==Setting Up for Documentation Writing==
The process for submitting a documentation patch is the same as for source code. For more information, read the [[Qt Contribution Guidelines]] page.
Here are the basic steps to help you get started contributing to the Qt documentation:
#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]].
#Start by contributing small fixes. Don't hesitate to ask for help!
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. It is possible to create a documentation set for Qt modules and tools.
*[http://doc-snapshots.qt.io/qt6-dev/qdoc-index.html QDoc Manual]
*[[QDocRegressionTesting]] - how to test the Qt documentation set
*[[Building Qt Documentation]]
==Writing Guidelines==
The Qt Writing Guidelines can with creating and editing Qt documentation. We adhere to it for consistency and to create a singular voice. We also follow the QUIP system and follow the requirements regarding examples and images.
*[[Qt Writing Guidelines]]
==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 fill in the '''Component''' field with '''Documentation''' ''and'' the relevant Qt library or tool. 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 fill in the '''Component''' field with '''Documentation''' ''and'' the relevant Qt library or tool. 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 [http://doc-snapshots.qt.io/ doc-snapshots.qt.io]
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/ doc-snapshots.qt.io]

Latest revision as of 13:28, 29 November 2024

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 expertise in a particular area are typically co-located with the developers of that area.

Documentation Snapshots

Currently, Qt documentation is hosted online at:

Also, when installing a version of Qt and Qt Creator, an offline documentation set of that particular release is included.

Getting Help with Editing

For documentation reviews, you may add the following for reviews:

Qt Oslo - Qt Reference Documentation and QDoc:

Qt Berlin - Qt Tools (Qt Creator, Qt Assistant, and others), Foundations team

Qt Oulu - Qt Products

  • Esa Törmänen (Qt for MCU documentation)
  • Inkamari Harjula (Boot2Qt documentation)
  • Johanna Vanhatapio (Qt Design Studio documentation)
  • Mats Honkamaa (Qt Design Studio documentation)
  • Nicholas Bennet (Platform documentation)
  • Pranta Dastider (Qt Design Studio documentation)
  • Teea Põldsam (Qt Design Studio and Qt License Server documentation)


Also, the following people can help with English and technical reviews:

Setting Up for Documentation Writing

The process for submitting a documentation patch is the same as for source code. For more information, read the Qt Contribution Guidelines page.

Here are the basic steps to help you get started contributing to the Qt documentation:

  1. Familiarize yourself with the development process. In particular, the process of contributing code.
  2. Create a Jira account and set up your Gerrit environment.
  3. Download the Qt sources.
  4. Read the page regarding code reviews.
  5. Start by contributing small fixes. Don't hesitate to ask for help!

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. It is possible to create a documentation set for Qt modules and tools.

Writing Guidelines

The Qt Writing Guidelines can with creating and editing Qt documentation. We adhere to it for consistency and to create a singular voice. We also follow the QUIP system and follow the requirements regarding examples and images.

Filing Documentation Issues

Anybody with a Jira account may file a bug. For documentation bugs, please file the issue and fill in the Component field with Documentation and the relevant Qt library or tool. 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

Retrieved from "https://wiki.qt.io/index.php?title=Contributing_to_Qt_Documentation&oldid=43357"