Merge remote-tracking branch 'foosel/maintenance'

.github/ISSUE_TEMPLATE.md

@@ -1,8 +1,10 @@
 READ THE FOLLOWING FIRST:
 
 If not already done, please read the "guidelines for contributing"
-that are linked ^-- just up there in the big yellow box. Also read
-the FAQ: https://github.com/foosel/OctoPrint/wiki/FAQ.
+aka the Contribution Guidelines that are linked ^-- just up there
+in the big yellow box.
+
+Also read the FAQ: https://github.com/foosel/OctoPrint/wiki/FAQ.
 
 This is a bug and feature tracker, please only use it to report bugs
 or request features within OctoPrint (not OctoPi, not any OctoPrint
@@ -14,18 +16,18 @@ for contributing" linked above, read it!), NOT here.
 
 Mark requests with a "[Request]" prefix in the title please. Fully fill
 out the bug reporting template for bug reports (if you don't know where
-to find some information - it's all described in the contribution
-guidelines linked up there in the big yellow box).
+to find some information - it's all described in the Contribution
+Guidelines linked up there in the big yellow box).
 
-When reporting a bug do NOT delete any lines from the template but
+When reporting a bug do NOT delete ANY lines from the template but
 those enclosed in [ and ] - and those please DO delete, they are
 only provided for your information and removing them makes your
 ticket more readable :)
 
-Make sure any bug you want to repor tis still present with the CURRENT
+Make sure any bug you want to report is still present with the CURRENT
 OctoPrint version and that it does not vanish when you start OctoPrint
-in safe mode - how to do that is also explained in the contribution
-guidelines linked up there in the big yellow box.
+in safe mode - how to do that is also explained in the Contribution
+Guidelines linked up there in the big yellow box.
 
 Thank you!
 
@@ -37,41 +39,54 @@ by heart ;))
 
 #### What were you doing?
 
-[Please describe the steps to reproduce your issue. Be as specific as
-possible here. The maintainers will need to reproduce your issue in
-order to fix it and that is not possible if they don't know what you
-did to get it to happen in the first place.
+[Please be as specific as possible here. The maintainers will need to
+reproduce your issue in order to fix it and that is not possible if they
+don't know what you did to get it to happen in the first place.
+
+Ideally provide exact steps to follow in order to reproduce your problem:
+
+1. ...
+2. ...
+3. ...
 
 If you encountered a problem with specific files of any sorts, make sure
 to also include a link to a file with which to reproduce the problem.]
 
-#### What did you expect to happen and what happened instead?
+#### What did you expect to happen?
+
+#### What happened instead?
+
+#### Did the same happen when running OctoPrint in safe mode?
+
+[Try to reproduce your problem in safe mode. You can find information
+on how to enable safe mode in the Contribution Guidelines.]
 
 #### Branch & Commit or Version of OctoPrint
 
 [Can be found in the lower left corner of the web interface. ALWAYS INCLUDE.]
 
 #### Operating System running OctoPrint
 
-[OctoPi, Linux, Windows, MacOS, something else? With version please.]
+[OctoPi, Linux, Windows, MacOS, something else? With version please.
+OctoPi's version can be found in /etc/octopi_version]
 
 #### Printer model & used firmware incl. version
 
 [If applicable, always include if unsure.]
 
 #### Browser and Version of Browser, Operating System running Browser
 
-[If applicable, always include if unsure or reporting UI issues.]
+[If applicable, always include if unsure.]
 
 #### Link to octoprint.log
 
-[On gist.github.com or pastebin.com. ALWAYS INCLUDE and never truncate.]
+[On gist.github.com or pastebin.com. ALWAYS INCLUDE and never truncate.
+The Contribution Guidelines tell you where to find that.]
 
 #### Link to contents of terminal tab or serial.log
 
 [On gist.github.com or pastebin.com. If applicable, always include if unsure or
-reporting any kind of communication issues between OctoPrint and your printer.
-Never truncate.
+reporting communication issues. Never truncate.
 
 serial.log is usually not written due to performance reasons and must be
 enabled explicitly. Provide at the very least the FULL contents of your
@@ -81,9 +96,11 @@ a serial.log.]
 #### Link to contents of Javascript console in the browser
 
 [On gist.github.com or pastebin.com or alternatively a screenshot. If applicable -
-always include if unsure or reporting UI issues.]
+always include if unsure or reporting UI issues.
+
+The Contribution Guidelines tell you where to find that.]
 
-#### Screenshot(s) or video(s) showing the problem:
+#### Screenshot(s)/video(s) showing the problem:
 
 [If applicable. Always include if unsure or reporting UI issues.]
 

.versioneer-lookup

@@ -16,11 +16,11 @@ prerelease
 HEAD
 \(detached.*
 
-# maintenance is currently the branch for preparation of maintenance release 1.3.2
+# maintenance is currently the branch for preparation of maintenance release 1.3.3
 # so are any fix/... and improve/... branches
-maintenance 1.3.2 6393de8c7d42a8bbddcab7cdbb6530ea88a8c82d pep440-dev
-fix/.* 1.3.2 6393de8c7d42a8bbddcab7cdbb6530ea88a8c82d pep440-dev
-improve/.* 1.3.2 6393de8c7d42a8bbddcab7cdbb6530ea88a8c82d pep440-dev
+maintenance 1.3.3 0a69dbeddb301d5a32827a3f0d561f875df24234 pep440-dev
+fix/.* 1.3.3 0a69dbeddb301d5a32827a3f0d561f875df24234 pep440-dev
+improve/.* 1.3.3 0a69dbeddb301d5a32827a3f0d561f875df24234 pep440-dev
 
 # every other branch is a development branch and thus gets resolved to 1.4.0-dev for now
 .* 1.4.0 7f5d03d0549bcbd26f40e7e4a3297ea5204fb1cc pep440-dev

AUTHORS.md

@@ -79,6 +79,7 @@ date of first contribution):
   * [Greg Hulands](https://github.com/ghulands)
   * [Andreas Werner](https://github.com/gallore)
   * [Shawn Bruce](https://github.com/kantlivelong)
+  * [Claudiu Ceia] (https://github.com/ClaudiuCeia)
 
 OctoPrint started off as a fork of [Cura](https://github.com/daid/Cura) by
 [Daid Braam](https://github.com/daid). Parts of its communication layer and

CONTRIBUTING.md

@@ -142,17 +142,33 @@ only provided here as some additional information for you), **even if only addin
     reproduce your issue in order to fix it and that is not possible if they
     don't know what you did to get it to happen in the first place.
 
+    Ideally provide exact steps to follow in order to reproduce your problem:
+
+    1. ...
+    2. ...
+    3. ...
+
     If you encountered a problem with specific files of any sorts, make sure
     to also include a link to a file with which to reproduce the problem.]
 
     #### What did you expect to happen?
 
     #### What happened instead?
 
+    #### Did the same happen when running OctoPrint in safe mode?
+
+    [Try to reproduce your problem in safe mode. You can find information
+    on how to enable safe mode in the Contribution Guidelines.]
+
     #### Branch & Commit or Version of OctoPrint
 
     [Can be found in the lower left corner of the web interface. ALWAYS INCLUDE.]
 
+    #### Operating System running OctoPrint
+
+    [OctoPi, Linux, Windows, MacOS, something else? With version please,
+    OctoPi's version can be found in /etc/octopi_version]
+
     #### Printer model & used firmware incl. version
 
     [If applicable, always include if unsure.]
@@ -163,7 +179,8 @@ only provided here as some additional information for you), **even if only addin
 
     #### Link to octoprint.log
 
-    [On gist.github.com or pastebin.com. ALWAYS INCLUDE and never truncate.]
+    [On gist.github.com or pastebin.com. ALWAYS INCLUDE and never truncate.
+    The Contribution Guidelines tell you where to find that.]
 
     #### Link to contents of terminal tab or serial.log
 
@@ -178,16 +195,19 @@ only provided here as some additional information for you), **even if only addin
     #### Link to contents of Javascript console in the browser
 
     [On gist.github.com or pastebin.com or alternatively a screenshot. If applicable -
-    always include if unsure or reporting UI issues.]
+    always include if unsure or reporting UI issues.
+
+    The Contribution Guidelines tell you where to find that.]
 
-    #### Screenshot(s) showing the problem:
+    #### Screenshot(s)/video(s) showing the problem:
 
     [If applicable. Always include if unsure or reporting UI issues.]
 
     I have read the FAQ.
 
-Copy-paste this template **completely**. Do not skip any lines or the bot
-*will* complain!
+Copy-paste this template **completely** (or use the version that gets pre-filled
+into the "new issue" form). Do not skip any lines or the bot *will* complain! Provide
+all requested information or your ticket will be closed.
 
 ### Where can I find which version and branch I'm on?
 
@@ -360,7 +380,7 @@ Those usually have one of the following prefixes:
   * `dev/...` or `feature/...`: New functionality under development that is to be merged
     into the `devel` branch.
 
-There is also the `gh-pages` branch, which holds OctoPrint's web page, and a couple of
+There is also the `gh-pages` branch, which holds OctoPrint's web page, and a few
 older development branches that are slowly being migrated or deleted.
 
 ## How OctoPrint is versioned
@@ -405,6 +425,7 @@ the local version identifier to allow for an exact determination of the active c
   * 2017-03-09: Allow PRs against `maintenance` branch for bugs in stable.
   * 2017-03-10: Reproduce bugs in safe mode to make sure they are really caused
     by OctoPrint itself and not a misbehaving plugin.
+  * 2017-03-27: Added safe mode section to ticket template.
 
 ## Footnotes
   * [1] - If you are wondering why, the problem is that anything that you add

README.md

@@ -67,7 +67,7 @@ and at its settings.
 
 ## Dependencies
 
-OctoPrint depends on a couple of python modules to do its job. Those are automatically installed when installing
+OctoPrint depends on a few python modules to do its job. Those are automatically installed when installing
 OctoPrint via `setup.py`:
 
     python setup.py install

docs/api/datamodel.rst

@@ -31,7 +31,7 @@ Printer State
    * - ``flags``
      - 1
      - Printer state flags
-     - A couple of boolean printer state flags
+     - A few boolean printer state flags
    * - ``flags.operational``
      - 1
      - Boolean

docs/api/settings.rst

@@ -68,6 +68,23 @@ Save settings
         // ...
       }
 
+.. _sec-api-settings-generateapikey:
+
+Regenerate the system wide API key
+==================================
+
+.. http:post:: /api/settings/apikey
+
+   Generates a new system wide API key.
+
+   Does not expect a body. Will return the generated API key as ``apikey``
+   property in the JSON object contained in the response body.
+
+   Requires admin rights.
+
+   :status 200:     No error
+   :status 403:     No admin rights
+
 .. _sec-api-settings-datamodel:
 
 Data model
@@ -87,6 +104,9 @@ mapped from the same fields in ``config.yaml`` unless otherwise noted:
      -
    * - ``api.key``
      - Only maps to ``api.key`` in ``config.yaml`` if request is sent with admin rights, set to ``n/a`` otherwise.
+       Starting with OctoPrint 1.3.3 setting this field via :ref:`the API <sec-api-settings-save>` is not possible,
+       only :ref:`regenerting it <sec-api-settings-generateapikey>` is supported. Setting a custom value is only
+       possible through `config.yaml`.
    * - ``api.allowCrossOrigin``
      -
    * - ``appearance.name``

docs/configuration/config_yaml.rst

@@ -943,8 +943,8 @@ Use the following settings to configure the server:
      * ``X-Scheme``: should contain your custom URL scheme to use (if different from ``http``), e.g. ``https``
 
    If you use these headers OctoPrint will work both via the reverse proxy as well as when called directly. Take a look
-   `into OctoPrint's wiki <https://github.com/foosel/OctoPrint/wiki/Reverse-proxy-configuration-examples>`_ for a couple
-   of examples on how to configure this.
+   `into OctoPrint's wiki <https://github.com/foosel/OctoPrint/wiki/Reverse-proxy-configuration-examples>`_ for some
+   examples on how to configure this.
 
 .. _sec-configuration-config_yaml-slicing:
 

docs/events/index.rst

@@ -152,7 +152,7 @@ File handling
 -------------
 
 Upload
-   A file has been uploaded.
+   A file has been uploaded through the web interface.
 
    Payload:
      * ``name``: the file's name
@@ -165,19 +165,74 @@ Upload
 
       Still available for reasons of backwards compatibility. Will be removed with 1.4.0.
 
+FileAdded
+   A file has been added to a storage.
+
+   Payload:
+     * ``storage``: the storage's identifier
+     * ``path``: the file's path within its storage location
+     * ``name``: the file's name
+     * ``type``: the file's type, a list of the path within the type hierarchy, e.g. ``["machinecode", "gcode"]`` or
+       ``["model", "stl"]``
+
+   .. note::
+
+      A copied file triggers this for its new path. A moved file first triggers ``FileRemoved`` for its original
+      path and then ``FileAdded`` for the new one.
+
+FileRemoved
+   A file has been removed from a storage.
+
+   Payload:
+     * ``storage``: the storage's identifier
+     * ``path``: the file's path within its storage location
+     * ``name``: the file's name
+     * ``type``: the file's type, a list of the path within the type hierarchy, e.g. ``["machinecode", "gcode"]`` or
+       ``["model", "stl"]``
+
+   .. note::
+
+      A moved file first triggers ``FileRemoved`` for its original path and then ``FileAdded`` for the new one.
+
+FolderAdded
+   A folder has been added to a storage.
+
+   Payload:
+     * ``storage``: the storage's identifier
+     * ``path``: the folders's path within its storage location
+     * ``name``: the folders's name
+
+   .. note::
+
+      A copied folder triggers this for its new path. A moved folder first triggers ``FolderRemoved`` for its original
+      path and then ``FolderAdded`` for the new one.
+
+FolderRemoved
+   A folder has been removed from a storage.
+
+   Payload:
+     * ``storage``: the storage's identifier
+     * ``path``: the folders's path within its storage location
+     * ``name``: the folders's name
+
+   .. note::
+
+      A moved folder first triggers ``FolderRemoved`` for its original path and then ``FolderAdded`` for the new one.
+
 UpdatedFiles
    A file list was modified.
 
    Payload:
 
-     * ``type``: the type of file list that was modified. Currently only ``printables`` and ``gcode`` (DEPRECATED) are supported here.
+     * ``type``: the type of file list that was modified. Only ``printables`` is supported here. See the deprecation
+       note below.
+
+       .. deprecated:: 1.2.0
 
-       .. note::
+          The ``gcode`` modification type has been superceeded by ``printables``. It is currently still available for
+          reasons of backwards compatibility and will also be sent on modification of ``printables``. It will however
+          be removed with 1.4.0.
 
-          The type ``gcode`` has been renamed to ``printables`` with the introduction of a new file management layer that
-          supports STL files as first class citizens as well. For reasons of backwards compatibility the ``UpdatedFiles``
-          event for printable files will be fired twice, once with ``type`` set to ``gcode``, once set to ``printables``.
-          Support for the ``gcode`` type will be removed in the next release after version 1.2.0.
 
 MetadataAnalysisStarted
    The metadata analysis of a file has started.

docs/features/gcode_scripts.rst

@@ -15,7 +15,7 @@ on Windows and ``~/Library/Application Support/OctoPrint`` on MacOS).
 
 These GCODE scripts are backed by the templating engine `Jinja2 <http://jinja.pocoo.org/>`_, allowing more than just
 simple "send-as-is" scripts but making use of a full blown templating language in order to create your scripts. To
-this end, OctoPrint injects a couple of variables into the :ref:`template rendering context <sec-features-gcode_scripts-context>`
+this end, OctoPrint injects some variables into the :ref:`template rendering context <sec-features-gcode_scripts-context>`
 as described below.
 
 .. _sec-features-gcode_scripts-predefined:
@@ -64,7 +64,7 @@ All GCODE scripts have access to the following template variables through the te
   * ``script``: An object wrapping the script's type (``gcode``) and name (e.g. ``afterPrintCancelled``) as ``script.type``
     and ``script.name`` respectively.
 
-There are a couple of additional template variables available for the following specific scripts:
+There are a few additional template variables available for the following specific scripts:
 
   * ``afterPrintPaused`` and ``beforePrintResumed``