diff --git a/projects/git-etc.html b/projects/git-etc.html
index 4d90176..1278edb 100644
--- a/projects/git-etc.html
+++ b/projects/git-etc.html
@@ -6,7 +6,7 @@ short: git-etc
hasgui: true
hasdocs: false
developers:
- - Evgeniy Alelseev
+ - Evgeniy Alekseev
license: GPLv3
links:
- Archlinux AUR package
diff --git a/projects/index.html b/projects/index.html
index ebbca7a..bc13a24 100644
--- a/projects/index.html
+++ b/projects/index.html
@@ -94,6 +94,13 @@ groups:
- GitHub repo
- Page on kde-apps.org
- Archlinux AUR package
+ - title: Report a Bug
+ short: reportabug
+ description: Qt application/library which allows users to create an issue for projects which are hosted on GitHub. It may work over GitHub or GitReport.
+ links:
+ - Homepage
+ - GitHub repo
+
---
diff --git a/projects/netctl-gui.html b/projects/netctl-gui.html
index cb9c4b7..35e1bac 100644
--- a/projects/netctl-gui.html
+++ b/projects/netctl-gui.html
@@ -6,7 +6,7 @@ short: netctl-gui
hasgui: true
hasdocs: true
developers:
- - Evgeniy Alelseev
+ - Evgeniy Alekseev
license: GPLv3
links:
- Page on
Softpedia
diff --git a/projects/oblikuestrategies.html b/projects/oblikuestrategies.html
index a7190db..51277e3 100644
--- a/projects/oblikuestrategies.html
+++ b/projects/oblikuestrategies.html
@@ -6,7 +6,7 @@ short: oblikuestrategies
hasgui: true
hasdocs: false
developers:
- - Evgeniy Alelseev
+ - Evgeniy Alekseev
license: GPL
links:
- Page on
kde-look.org
diff --git a/projects/pytextmonitor.html b/projects/pytextmonitor.html
index c873ed5..275f424 100644
--- a/projects/pytextmonitor.html
+++ b/projects/pytextmonitor.html
@@ -6,7 +6,7 @@ short: pytextmonitor
hasgui: true
hasdocs: false
developers:
- - Evgeniy Alelseev
+ - Evgeniy Alekseev
- Ernesto Avilés Vzqz (Spanish translation)
- Mermouy (French translation)
- underr (Brazillian Portuguese translation)
diff --git a/projects/queued.html b/projects/queued.html
index 8afc32b..fd37e46 100644
--- a/projects/queued.html
+++ b/projects/queued.html
@@ -6,7 +6,7 @@ short: queued
hasgui: false
hasdocs: false
developers:
- - Evgeniy Alelseev
+ - Evgeniy Alekseev
license: GPLv3
links:
---
diff --git a/projects/reportabug.html b/projects/reportabug.html
new file mode 100644
index 0000000..aa72694
--- /dev/null
+++ b/projects/reportabug.html
@@ -0,0 +1,159 @@
+---
+hastr: true
+layout: project
+title: Report a Bug
+short: reportabug
+hasgui: false
+hasdocs: true
+developers:
+ - Evgeniy Alekseev
+license: LGPLv3
+links:
+---
+
+
Information
+
Qt application/library which allows users to create an issue for projects which are hosted on GitHub. It may work over GitHub or GitReport.
+
+
Developers and contributors
+
+ {% for devel in page.developers %}
+ - {{ devel }}
+ {% endfor %}
+
+
+
License
+
+
+
+
+
Installation
+
+
Instruction
+
Build as a single application
+
+ - Download the actual source tarball.
+ - Extract it and set up your configuration.
+ - Install the application:
+
+{% highlight bash %}
+cd /path/to/extracted/archive
+mkdir build && cd build
+cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DBUILD_AS_LIBRARY:BOOL=0 ../
+make
+sudo make install
+{% endhighlight %}
+
+
+
+
+
Build as a library in your project
+
+ - Download the actual source tarball.
+ - Extract it and set up your configuration.
+ - include it into your project. For example if you use
cmake
:
+
+{% highlight cmake %}
+add_subdirectory (reportabug)
+{% endhighlight %}
+
+
+ - Declare class in you sources. For example:
+
+{% highlight cpp %}
+Reportabug *reportWindow = new Reportabug(this, false);
+reportWindow->showWindow();
+{% endhighlight %}
+
+
+ - Link your application with this library.
+
+
+
Available cmake flags:
+
+ -DBUILD_AS_LIBRARY:BOOL=0
- build the application but not a shared library.
+ -DBUILD_DOCS:BOOL=1
- build developer documentation.
+ -DENABLE_GITHUB=0
- disable GitHub module.
+ -DENABLE_GITREPORT=0
- disable GitReport module.
+ -DOWN_GITHUB_TOKEN=STRING
- use STRING as own GitHub token.
+ -DUSE_QT5:BOOL=0
- use Qt4 instead of Qt5.
+
+
+
Dependencies
+
I want note that all were tested on latest version of dependencies.
+
+ - qt5-base (if Qt5 is used) or qt4 (if Qt4 is used)
+ - automoc4 (make)
+ - cmake (make)
+ - doxygen (make, documentation)
+ - qt5-network (if Qt5 is used) (optional, required by GitHub module)
+ - qt5-webkit (if Qt5 is used) or qtwebkit (if Qt4 is used) (optional, required by GitReports module)
+
+
+
+
+
How to use
+
GitHub module
+
+
This module creates an issue over GitHub. GitHub API is used for creating issue. User should type own username and password. The typical POST request is:
+
+{% highlight bash %}
+curl -X POST -u user:pass -d '{"title":"A new bug","body":"Some error occurs"}' \
+ https://api.github.com/repos/owner/repo/issues
+{% endhighlight %}
+
+
To disable this module use -DENABLE_GITHUB=0
cmake flag.
+
+
This module may send request using developer's token too. Please visit this page and generate a new one. Needed scopes are public_repo
(or repo
if you will use it for a private repository).
+Please keep in mind that passing the token in the clear, you may discredit your account.
+
+
The typical POST request is:
+
+{% highlight bash %}
+curl -X POST -H "Authorization: token token" -d '{"title":"A new bug","body":"Some error occurs"}' \
+ https://api.github.com/repos/owner/repo/issues
+{% endhighlight %}
+
+
To enable this module set up your token using -DOWN_GITHUB_TOKEN=0
cmake flag.
+
+
This module requires QtNetwork
module.
+
+
GitReports module
+
This module creates issue over GitReports. Please visit this page and set up it for your repository.
+
+
To disable this module use -DENABLE_GITREPORT=0
cmake flag. This module requires QtWebKit
module.
+
+
+
+
Configuration
+
For the developer configuration please use config.h.in
header.
+
Main configuration
+
+ OWNER
- the owner of the source repository.
+ PROJECT
- the project name.
+ TAG_BODY
- default body of an issue. It may be used for both modules.
+ TAG_TITLE
- default title of an issue. It may be used only for GitHub module.
+ TAG_ASSIGNEE
- assign an issue to this account. It may be used only for GitHub module. This tag will work only if user has push access. If it will be empty, it will be ignored.
+ TAG_LABELS
- set these labels to an issue. Labels should be comma separated. It may be used only for GitHub module. This tag will work only if user has push access. If it will be empty, it will be ignored.
+ TAG_MILESTONE
- set this milestone to an issue. It may be used only for GitHub module. This tag will work only if user has push access. If it will be empty, it will be ignored.
+
+
+
GitHub module settings
+
+ GITHUB_COMBOBOX
- text of this module into comboBox.
+ ISSUES_URL
- issues url, in the most cases do not touch it. Default is https://api.github.com/repos/$OWNER/$PROJECT/issues
. Available tags here are $PROJECT
, $OWNER
.
+
+
+
GitReports module settings
+
+ CAPTCHA_KEY
- captcha key. It may be found in the source of the PUBLIC_URL
page. Default is 7f6ef90bce7389088a52c5c9101aad206b21b56d
.
+ CAPTCHA_TEXT
- captcha text. It may be found in the source of the PUBLIC_URL
page. Default is QJNZXY
.
+ CAPTCHA_TIME
- captcha time. It may be found in the source of the PUBLIC_URL
page. Default is 1406531273
.
+ GITREPORT_COMBOBOX
- text of this module into comboBox.
+ PUBLIC_URL
- issues url, in the most cases do not touch it. Default is https://gitreports.com/issue/$OWNER/$PROJECT
. Available tags here are $PROJECT
, $OWNER
.
+
+
+
+
+
diff --git a/ru/projects/git-etc.html b/ru/projects/git-etc.html
index b6416f8..ffca1a3 100644
--- a/ru/projects/git-etc.html
+++ b/ru/projects/git-etc.html
@@ -7,7 +7,7 @@ short: git-etc
hasgui: true
hasdocs: false
developers:
- - Evgeniy Alelseev
+ - Evgeniy Alekseev
license: GPLv3
links:
- Пакет в
AUR
diff --git a/ru/projects/index.html b/ru/projects/index.html
index 5234c93..176de56 100644
--- a/ru/projects/index.html
+++ b/ru/projects/index.html
@@ -95,6 +95,12 @@ groups:
-
Репозиторий на GitHub
-
Страница на kde-apps.org
-
Пакет в AUR
+ - title: Report a Bug
+ short: reportabug
+ description: Приложение/библиотека, написанное на Qt, которое позволяет пользователям отправлять багрепорт для проектов, расположенных на GitHub. Оно может работать как через
GitHub, так и через
GitReports.
+ links:
+ -
Домашняя страница
+ -
Репозиторий на GitHub
---
diff --git a/ru/projects/netctl-gui.html b/ru/projects/netctl-gui.html
index d125196..756ba58 100644
--- a/ru/projects/netctl-gui.html
+++ b/ru/projects/netctl-gui.html
@@ -7,7 +7,7 @@ short: netctl-gui
hasgui: true
hasdocs: true
developers:
- - Evgeniy Alelseev
+ - Evgeniy Alekseev
license: GPLv3
links:
- Страница на
Softpedia
diff --git a/ru/projects/oblikuestrategies.html b/ru/projects/oblikuestrategies.html
index 23d7c06..3f60ab7 100644
--- a/ru/projects/oblikuestrategies.html
+++ b/ru/projects/oblikuestrategies.html
@@ -7,7 +7,7 @@ short: oblikuestrategies
hasgui: true
hasdocs: false
developers:
- - Evgeniy Alelseev
+ - Evgeniy Alekseev
license: GPL
links:
- Страница на
kde-look.org
diff --git a/ru/projects/pytextmonitor.html b/ru/projects/pytextmonitor.html
index c96a0e2..0902310 100644
--- a/ru/projects/pytextmonitor.html
+++ b/ru/projects/pytextmonitor.html
@@ -7,7 +7,7 @@ short: pytextmonitor
hasgui: true
hasdocs: false
developers:
- - Evgeniy Alelseev
+ - Evgeniy Alekseev
- Ernesto Avilés Vzqz (перевод на испанский)
- Mermouy (перевод на французский)
- underr (перевод на бразильский португальский)
diff --git a/ru/projects/queued.html b/ru/projects/queued.html
index db37ffa..f3c18f1 100644
--- a/ru/projects/queued.html
+++ b/ru/projects/queued.html
@@ -7,7 +7,7 @@ short: queued
hasgui: false
hasdocs: false
developers:
- - Evgeniy Alelseev
+ - Evgeniy Alekseev
license: GPLv3
links:
---
diff --git a/ru/projects/reportabug.html b/ru/projects/reportabug.html
index 3156716..9cb5ea6 100644
--- a/ru/projects/reportabug.html
+++ b/ru/projects/reportabug.html
@@ -7,13 +7,13 @@ short: reportabug
hasgui: false
hasdocs: true
developers:
- - Evgeniy Alelseev
+ - Evgeniy Alekseev
license: LGPLv3
links:
---
Информация
-
Приложение/библиотека, написанная на Qt, которое позволяет пользователям отправлять багрепорт для проектов, расположенных на GitHub. Оно может работать как через GitHub, так и через GitReports.
+
Приложение/библиотека, написанное на Qt, которое позволяет пользователям отправлять багрепорт для проектов, расположенных на GitHub. Оно может работать как через GitHub, так и через GitReports.
Разработчики
@@ -32,11 +32,11 @@ links:
Установка
Инструкция
-Сборка, как отдельное приложение:
+Сборка, как отдельное приложение
-Сборка, как библиотека в проекте:
+Сборка, как библиотека в проекте
- Скачайте архив с актуальной версией исходных файлов.
- Извлеките из него файлы и настройте под себя.
- Включите библиотеку в Ваш проект. Например, если Вы используете cmake
:
+ - Скачайте архив с актуальной версией исходных файлов.
+ - Извлеките из него файлы и настройте под себя.
+ - Включите библиотеку в Ваш проект. Например, если Вы используете
cmake
:
{% highlight cmake %}
add_subdirectory (reportabug)
{% endhighlight %}
- Объявите класс в Вашем приложении, например:
+ - Объявите класс в Вашем приложении, например:
{% highlight cpp %}
Reportabug *reportWindow = new Reportabug(this, false);
@@ -71,7 +71,7 @@ reportWindow->showWindow();
- Слинкуйте Ваше приложение с библиотекой.
-Доступные флаги cmake:
+Доступные флаги cmake
-DBUILD_AS_LIBRARY:BOOL=0
- собирать отдельное приложение, а не библиотеку.
-DBUILD_DOCS:BOOL=1
- собирать документацию для разработчиков.
@@ -115,14 +115,14 @@ curl -X POST -H "Authorization: token token" -d '{"title":"A new bug","body":"So
https://api.github.com/repos/owner/repo/issues
{% endhighlight %}
-Для того, чтобы включить данный модуль, используйте --DOWN_GITHUB_TOKEN=STRING
флаг cmake.
+Для того, чтобы включить данный модуль, используйте -DOWN_GITHUB_TOKEN=STRING
флаг cmake.
-Данный модуль требует наличия в системе qt5-network.
+Данный модуль требует наличия в системе QtNetwork
.
Модуль GitReports
Данный модуль создает тикет, используя возможности GitReports. Пожалуйста, посетите данную страницу и настройте под Ваши репозитории.
-Для того, чтобы отключить данный модуль, используйте -DENABLE_GITREPORT=0
флаг cmake. Данный модуль требует наличия в системе qt5-webkit.
+Для того, чтобы отключить данный модуль, используйте -DENABLE_GITREPORT=0
флаг cmake. Данный модуль требует наличия в системе QtWebKit
.