Rewords release notes

NEWS.rst

@@ -1,50 +1,64 @@
 Release Notes
 =============
 
-3.0.2-38
---------
+3.0.3
+-----
 
 Release Summary
 ~~~~~~~~~~~~~~~
 
-This minor release only focussed on fixing problems raisen by Guake enthousiasts that tested Guake
-3.0.0.
+This minor release mainly focus on fixing big problems that was remaining after the migration to
+GTK3. I would like to akwonledge the work of some contributors that helped testing and reporting
+issues on Guake 3.0.0. Thanks a lot to @egmontkob and @aichingm.
 
-The Preference window has been deeply reworked and the hotkey management page has been fixed.
+The Preference window has been deeply reworked and the hotkey management has been rewriten. This was
+one the the major regression in Guake 3.0.
 
 New Features
 ~~~~~~~~~~~~
 
-- Development environment: automatically open reno slug after creation for editing
+- [dev env] automatically open reno slug after creation for editing
+
+- [dev env]: Add the possibility to terminate guake with ``Ctrl+c`` on terminal where Guake has
+  been launched
 
-- Add "Infinite scrolling" option in "Scrolling" panel
+- Add "Infinite scrolling" option in "Scrolling" panel #274
 
 - Added hotkey for showing and focusing Guake window when it is opened or closed. It is convenient
   when Guake window are overlapped with another windows and user needs to just showing it without
-  closing and opening it again.
+  closing and opening it again. #1133
+
+Known Issues
+~~~~~~~~~~~~
+
+- Quick Edit feature is not working (#1121)
+
+Deprecations
+~~~~~~~~~~~~
+
+- Remove visible bell feature #1081
 
 Bug Fixes
 ~~~~~~~~~
 
-- Guake does not work #1119
-
-- 2 issues - command options don't work, crash when disabling keybinding #1111 (only the first
-  issue) [gtk3] Guake window is open upon startup #1113
+- Command options do not work, crash when disabling keybinding #1111
 
-- [gtk3] Crash on increase/decrease height shortcut #1099
+- Do not open Guake window upon startup #1113
 
-- [gtk3] Conflicting default shortcut of Ctrl+F2 #1101
+- Fix crash on increase/decrease main window height shortcut #1099
 
-- Preference panel was buggy and unesthetic.
+- Resolved conflicting default shortcut for ``Ctrl+F2`` (now, rename current tab is set to
+  ``Ctrl+Shift+R``) #1101, #1098
 
 - The hotkey management has been rewriten and is now fully functional
 
 - Rework the Preference window and reorganize the settings. Lot of small issues has been fixed. The
   Preference window now fits in a 1024x768 screen.
 
-- [gtk3] Remove or manually implement visible bell #1081
+- Fix 'Failed to execute child process "-"' - #1119
 
-- fix history size spin
+- History size spin is fixed and now increment by 1000 steps. Default history value is now set to
+  1000, because "1024" has no real meaning for end user. #1082
 
 Translation Updates
 ~~~~~~~~~~~~~~~~~~~
@@ -55,6 +69,17 @@ Translation Updates
 
 - ru
 
+Other
+~~~~~
+
+- The dependencies of the Guake executable has been slightly better described in README. There is
+  an example for Debian/Ubuntu in the file ``bootstrap-dev-debian.sh`` which is the main
+  environment where Guake is developed and tested.
+
+- Package maintainers are encouraged to submit their ``bootstrap-dev-[distribution].sh``,
+  applicable for other distributions, to help users install Guake from source, and other package
+  maintainers.
+
 3.0.2
 -----
 
@@ -138,9 +163,9 @@ New Features
   - enforced code styling and checks using Pylint, Flake8, Yapf, ISort.
   - simpler release management thanks to PBR
 
-- `reno <https://docs.openstack.org/reno/latest/>`_ will be used to generate release notes for
-  Guake starting version 3.0.0. It allows developers to write the right chunk that will appear in
-  the release note directly from their Pull Request.
+- [dev env] `reno <https://docs.openstack.org/reno/latest/>`_ will be used to generate release
+  notes for Guake starting version 3.0.0. It allows developers to write the right chunk that will
+  appear in the release note directly from their Pull Request.
 
 - Update Guake window title when:
   - the active tab changes

README.rst

@@ -38,6 +38,9 @@ Guake has recently been ported Gtk3, thanks to the huge work of @aichingm.
 Old releases and code depending on GTK2 have been put on the
 `0.8.x <https://github.com/Guake/guake/tree/0.8.x>`_ branch and will no more be actively maintained.
 
+Please note that we target to support mainly the GTK and VTE versions found by default on most
+popular distribution such as Ubuntu LTS (currently: Ubuntu 16.04 LTS and 17.10).
+
 Guake has also been ported to Python 3.5+.
 
 Dropped Features from Guake 0.8.x
@@ -50,6 +53,8 @@ Dependencies
 
 Here are the dependencies of Guake for its execution:
 
+- GTK: 3.18
+- VTE: 2.91 (`vte-0.42 <https://packages.ubuntu.com/xenial/gir1.2-vte-2.91>`_)
 - ``gir1.2-keybinder-3.0``
 - ``gir1.2-notify-0.7``
 - ``gir1.2-vte-2.91``

guake/guake_app.py

@@ -32,7 +32,7 @@
 
 import gi
 gi.require_version('Gtk', '3.0')
-gi.require_version('Vte', '2.91')  # vte-0.38
+gi.require_version('Vte', '2.91')  # vte-0.42
 gi.require_version('Keybinder', '3.0')
 from gi.repository import GLib
 from gi.repository import GObject

releasenotes/config.yaml

@@ -13,67 +13,58 @@ sections:
   - [security, Security Issues]
   - [fixes, Bug Fixes]
   - [translations, Translation Updates]
+  - [notes_for_package_maintainers, Notes for Package Maintainers]
   - [other, Other]
 # Change prelude_section_name to 'release_summary' from default value
 # 'prelude'.
 prelude_section_name: release_summary
 template: |
   release_summary: >
     Replace this text with content to appear at the top of the section for this
-    release. All of the prelude content is merged together and then rendered
+    release.
+
+    All of the prelude content is merged together and then rendered
     separately from the items listed in other parts of the file, so the text
     needs to be worded so that both the prelude and the other items make sense
-    when read independently. This may mean repeating some details. Not every
-    release note requires a prelude. Usually only notes describing major
-    features or adding release theme details should have a prelude.
+    when read independently.
+
+    Do not use "list" syntax here
   features:
     - |
-      List new features here, or remove this section.  All of the list items in
-      this section are combined when the release notes are rendered, so the text
-      needs to be worded so that it does not depend on any information only
-      available in another section, such as the prelude. This may mean repeating
-      some details.
+      List new features here followed by the ticket number, for example::
+
+        - new exiting feature #1234
+
   known_issues:
     - |
-      List known issues here, or remove this section.  All of the list items in
-      this section are combined when the release notes are rendered, so the text
-      needs to be worded so that it does not depend on any information only
-      available in another section, such as the prelude. This may mean repeating
-      some details.
+      List know issue introduced by the change here, followed if possible by a
+      ticket number, for example::
+
+        - such other feature is broken #1234
+
   upgrade:
     - |
-      List upgrade notes here, or remove this section.  All of the list items in
-      this section are combined when the release notes are rendered, so the text
-      needs to be worded so that it does not depend on any information only
-      available in another section, such as the prelude. This may mean repeating
-      some details.
+      List upgrade note for end users here
   deprecations:
     - |
-      List deprecations notes here, or remove this section.  All of the list
-      items in this section are combined when the release notes are rendered, so
-      the text needs to be worded so that it does not depend on any information
-      only available in another section, such as the prelude. This may mean
-      repeating some details.
+      List deprecations notes heres, ie, feature that are being removed by the
+      change.
   security:
     - |
-      Add security notes here, or remove this section.  All of the list items in
-      this section are combined when the release notes are rendered, so the text
-      needs to be worded so that it does not depend on any information only
-      available in another section, such as the prelude. This may mean repeating
-      some details.
+      Add security notes here.
   fixes:
     - |
-      Add normal bug fixes here, or remove this section.  All of the list items
-      in this section are combined when the release notes are rendered, so the
-      text needs to be worded so that it does not depend on any information only
-      available in another section, such as the prelude. This may mean repeating
-      some details.
+      Add normal bug fixes here, followed by the ticket number, for example::
+
+        - broken feature has been fixed #1234
   translations:
-    - Only put list of updated language <lang> (ex: fr_FR)
+    - Only put list of updated language <lang>, for example::
+
+        - fr_FR
+
+  notes_for_package_maintainers:
+    - |
+      Add notes for package maintainers here.
   other:
     - |
-      Add other notes here, or remove this section.  All of the list items in
-      this section are combined when the release notes are rendered, so the text
-      needs to be worded so that it does not depend on any information only
-      available in another section, such as the prelude. This may mean repeating
-      some details.
+      Add other notes here.

releasenotes/notes/auto-edit-648e3609c9aee103.yaml

@@ -1,3 +1,3 @@
 features:
   - |
-    Development environment: automatically open reno slug after creation for editing
+    [dev env] automatically open reno slug after creation for editing

releasenotes/notes/dev-env-fb2967d1ba8ee495.yaml

@@ -0,0 +1,4 @@
+features:
+  - |
+    [dev env]: Add the possibility to terminate guake with ``Ctrl+c`` on terminal
+    where Guake has been launched

releasenotes/notes/fix-guake-showing-up-on-startup-0fdece37dc1616e4.yaml

@@ -1,4 +1,5 @@
 fixes:
   - |
-    2 issues - command options don't work, crash when disabling keybinding #1111 (only the first issue)
-    [gtk3] Guake window is open upon startup #1113
+    Command options do not work, crash when disabling keybinding #1111
+  - |
+    Do not open Guake window upon startup #1113

releasenotes/notes/fix-in/decrease-height-8176a8313d9a1aba.yaml

@@ -1,3 +1,3 @@
 fixes:
   - |
-    [gtk3] Crash on increase/decrease height shortcut #1099
+    Fix crash on increase/decrease main window height shortcut #1099

releasenotes/notes/fix-rename-tab-shortcut-62ad1410c2958929.yaml

@@ -1,3 +1,4 @@
 fixes:
   - |
-    [gtk3] Conflicting default shortcut of Ctrl+F2 #1101
+    Resolved conflicting default shortcut for ``Ctrl+F2`` (now, rename current tab is set to
+    ``Ctrl+Shift+R``) #1101, #1098

releasenotes/notes/gtk3-a429d01811754c42.yaml

@@ -1,7 +1,4 @@
 release_summary: >
-  This minor release only focussed on fixing problems raisen by Guake enthousiasts
-  that tested Guake 3.0.0.
-
-fixes:
-  - |
-    Preference panel was buggy and unesthetic.
+  This minor release mainly focus on fixing big problems that was remaining after the migration to
+  GTK3. I would like to akwonledge the work of some contributors that helped testing and reporting
+  issues on Guake 3.0.0. Thanks a lot to @egmontkob and @aichingm.

releasenotes/notes/packages-55d1017dd708b8de.yaml

@@ -0,0 +1,12 @@
+known_issues:
+  - |
+    Quick Edit feature is not working (#1121)
+other:
+  - |
+    The dependencies of the Guake executable has been slightly better described in README.
+    There is an example for Debian/Ubuntu in the file ``bootstrap-dev-debian.sh`` which is the main
+    environment where Guake is developed and tested.
+  - |
+    Package maintainers are encouraged to submit their ``bootstrap-dev-[distribution].sh``,
+    applicable for other distributions, to help users install Guake from source, and other package
+    maintainers.

releasenotes/notes/prefs-032d2ab0c8e2f17a.yaml

@@ -1,6 +1,6 @@
 release_summary: >
-  The Preference window has been deeply reworked and the hotkey management page
-  has been fixed.
+  The Preference window has been deeply reworked and the hotkey management has been rewriten. This
+  was one the the major regression in Guake 3.0.
 
 fixes:
   - |

releasenotes/notes/reno-3b5ad9829b256250.yaml

@@ -1,7 +1,7 @@
 ---
 features:
   - |
-    `reno <https://docs.openstack.org/reno/latest/>`_ will be used to generate
+    [dev env] `reno <https://docs.openstack.org/reno/latest/>`_ will be used to generate
     release notes for Guake starting version 3.0.0.
     It allows developers to write the right chunk that will appear in the release
     note directly from their Pull Request.

releasenotes/notes/run-command-517683bd988aa06a.yaml

@@ -0,0 +1,3 @@
+fixes:
+  - |
+    Fix 'Failed to execute child process "-"' - #1119

releasenotes/notes/scroll-959087c80640ceaf.yaml

@@ -1,7 +1,8 @@
 features:
   - |
-    Add "Infinite scrolling" option in "Scrolling" panel
+    Add "Infinite scrolling" option in "Scrolling" panel #274
 
 fixes:
   - |
-    fix history size spin
+    History size spin is fixed and now increment by 1000 steps. Default history value is now set to
+    1000, because "1024" has no real meaning for end user. #1082

releasenotes/notes/show-focus-cab5307b44905f7e.yaml

@@ -2,4 +2,4 @@ features:
   - |
     Added hotkey for showing and focusing Guake window when it is opened or closed.
     It is convenient when Guake window are overlapped with another windows and user
-    needs to just showing it without closing and opening it again.
+    needs to just showing it without closing and opening it again. #1133

releasenotes/notes/visible-bell-12de7acf136d3fa4.yaml

@@ -0,0 +1,3 @@
+deprecations:
+  - |
+    Remove visible bell feature #1081