From a7693615d0b4a72cee3e99f0de9c3269e4605857 Mon Sep 17 00:00:00 2001 From: arcan1s Date: Wed, 30 Jul 2014 23:06:56 +0400 Subject: [PATCH] add reportabug pages and fix typo --- projects/git-etc.html | 2 +- projects/index.html | 7 ++ projects/netctl-gui.html | 2 +- projects/oblikuestrategies.html | 2 +- projects/pytextmonitor.html | 2 +- projects/queued.html | 2 +- projects/reportabug.html | 159 +++++++++++++++++++++++++++++ ru/projects/git-etc.html | 2 +- ru/projects/index.html | 6 ++ ru/projects/netctl-gui.html | 2 +- ru/projects/oblikuestrategies.html | 2 +- ru/projects/pytextmonitor.html | 2 +- ru/projects/queued.html | 2 +- ru/projects/reportabug.html | 30 +++--- 14 files changed, 197 insertions(+), 25 deletions(-) create mode 100644 projects/reportabug.html 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

+ + +

License

+ + + + +

Installation

+ +

Instruction

+

Build as a single application

+ + +

Build as a library in your project

+ + +

Available cmake flags:

+ + +

Dependencies

+

I want note that all were tested on latest version of dependencies.

+ + + + +

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

+ + +

GitHub module settings

+ + +

GitReports module settings

+ + + + + 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:

    Установка

    Инструкция

    -

    Сборка, как отдельное приложение:

    +

    Сборка, как отдельное приложение

      -

    • Скачайте архив с актуальной версией исходных файлов.

      • -

    • Извлеките из него файлы и настройте под себя.

      • -

    • Установите приложение:

      +
    • Скачайте архив с актуальной версией исходных файлов.
      • +
    • Извлеките из него файлы и настройте под себя.
      • +
    • Установите приложение: {% highlight bash %} cd /path/to/extracted/archive @@ -49,18 +49,18 @@ sudo make install
    -

    Сборка, как библиотека в проекте:

    +

    Сборка, как библиотека в проекте

      -

    • Скачайте архив с актуальной версией исходных файлов.

      • -

    • Извлеките из него файлы и настройте под себя.

      -

    • Включите библиотеку в Ваш проект. Например, если Вы используете 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.