Permalink
Browse files

Preparing release of 1.2.16

1 parent 26fb208 commit 354042b84d488db38ac1917bb69bd164f4e7f750 @foosel committed Sep 23, 2016
Showing with 56 additions and 51 deletions.
  1. +20 −10 .github/ISSUE_TEMPLATE.md
  2. +10 −15 CHANGELOG.md
  3. +18 −10 CONTRIBUTING.md
  4. +8 −16 README.md
@@ -1,21 +1,31 @@
-Please read the "guidelines for contributing" that are linked ^-- just
-up there. Also read the FAQ: https://github.com/foosel/OctoPrint/wiki/FAQ.
+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.
This is a bug and feature tracker, please only use it to report bugs
or request features within OctoPrint (not OctoPi, not any OctoPrint
-plugins and not unofficial OctoPrint versions). Mark requests with
-a [Request] prefix in the title please. Fully fill out the bug reporting
-template for bug reports. 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 :)
+plugins and not unofficial OctoPrint versions).
Do not seek support here ("I need help with ..."), that belongs on
the mailing list or the G+ community (both linked in the "guidelines
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). 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 :)
+
Thank you!
+(Before submitting your ticket, please delete this text up to and
+including the line too - it's only here for you, we already know it
+by heart ;))
+
----
#### What were you doing?
@@ -53,8 +63,8 @@ to also include a link to a file with which to reproduce the problem.]
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 contents of your
-terminal tab at the time of the bug occurence, even if you do not have
+enabled explicitly. Provide at the very least the FULL contents of your
+terminal tab at the time of the bug occurrence, even if you do not have
a serial.log.]
#### Link to contents of Javascript console in the browser
View
@@ -1,19 +1,6 @@
# OctoPrint Changelog
-## 1.2.16rc2 (2016-09-16)
-
-### Improvements
-
- * Return a "400 Bad Request" instead of a "500 Internal Server Error" if a `multipart/form-data` request (e.g. a file upload) is sent which lacks the `boundary` field.
-
-### Bug Fixes
-
- * [#1491](https://github.com/foosel/OctoPrint/issues/1491): Fixed generate/delete API key in the user settings
- * [#1492](https://github.com/foosel/OctoPrint/issues/1492): Fixed a bug in the software update plugin depending on the presence of the ``prerelease`` flag which is only present when added manually or using a non stable release channel.
-
-([Commits](https://github.com/foosel/OctoPrint/compare/1.2.16rc1...1.2.16rc2))
-
-## 1.2.16rc1 (2016-09-09)
+## 1.2.16 (2016-09-23)
### Improvements
@@ -23,6 +10,7 @@
* Improved fuzzy print time displays in the frontend. Rounding now takes overall duration into account - durations over a day will be rounded up/down to half days, durations over an hour will be rounded up/down to half hours, durations over 30min will be rounded to 10min segments, durations below 30min will be rounded up or down to the next minute depending on the seconds and finally if we are talking about less than a minute, durations over 30s will return "less than a minute", durations under 30s will return "a couple of seconds".
* Improved intermediary loading page: Don't report server as ready and reload until preliminary caching has been done, IF preliminary caching will be done.
* Added release channels to OctoPrint's bundled Software Update plugin. You will now be able to subscribe to OctoPrint's `maintenance` or `devel` release candidates in addition to stable versions. [Read more about Release Channels on the wiki](https://github.com/foosel/OctoPrint/wiki/Using-Release-Channels).
+ * Return a "400 Bad Request" instead of a "500 Internal Server Error" if a `multipart/form-data` request (e.g. a file upload) is sent which lacks the `boundary` field.
### Bug Fixes
@@ -31,8 +19,15 @@
* [#1478](https://github.com/foosel/OctoPrint/issues/1478): Don't display inaccurate linear estimate ("6 days remaining") until 30 *minutes* have passed, even if nothing else is available. Potentially related to [#1428](https://github.com/foosel/OctoPrint/issues/1428).
* [#1479](https://github.com/foosel/OctoPrint/issues/1479): Make sure set cookies are post fixed with a port specific suffix and that the path they are set on takes the script root from the request into account.
* [#1483](https://github.com/foosel/OctoPrint/issues/1483): Filenames in file uploads may also now be encoded in ISO-8859-1, as defined in [RFC 7230](https://tools.ietf.org/html/rfc7230#section-3.2.4). Solves an issue when sending files with non-ASCII-characters in the file name from Slic3r.
+ * [#1491](https://github.com/foosel/OctoPrint/issues/1491): Fixed generate/delete API key in the user settings
+ * [#1492](https://github.com/foosel/OctoPrint/issues/1492): Fixed a bug in the software update plugin depending on the presence of the ``prerelease`` flag which is only present when added manually or using a non stable release channel.
+
+### More information
-([Commits](https://github.com/foosel/OctoPrint/compare/1.2.15...1.2.16rc1))
+ * [Commits](https://github.com/foosel/OctoPrint/compare/1.2.15...1.2.16)
+ * Release Candidates:
+ * [1.2.16rc1](https://github.com/foosel/OctoPrint/releases/tag/1.2.16rc1)
+ * [1.2.16rc2](https://github.com/foosel/OctoPrint/releases/tag/1.2.16rc2)
## 1.2.15 (2016-07-30)
View
@@ -63,10 +63,11 @@ available for the maintainers to directly start tackling that problem.
## How to file a bug report
If you encounter an issue with OctoPrint, you are welcome to
-[submit a bug report](https://goo.gl/GzkGv9).
+[submit a bug report](https://github.com/foosel/OctoPrint/issues/new).
Before you do that for the first time though please take a moment to read the
-following section *completely*. Thank you! :)
+following section *completely* and also follow the instructions in the
+"new issue" form. Thank you! :)
### What should I do before submitting a bug report?
@@ -85,7 +86,7 @@ following section *completely*. Thank you! :)
might have installed**. Report any issues with those in their corresponding
bug tracker (probably linked to from the plugin's homepage).
- Finally, **this is also not the right issue tracker if you are running an
+ Finally, **this is also not the right issue tracker if you are running a
forked version of OctoPrint**. Seek help for such unofficial versions from
the people maintaining them instead.
@@ -123,7 +124,10 @@ following section *completely*. Thank you! :)
### What should I include in a bug report?
-Always use the following template (please remove what's within `[...]`, that's
+First of all make sure your use **a descriptive title**. "It doesn't work"
+and similar unspecific complaints are NOT descriptive titles.
+
+**Always use the following template** (please remove what's within `[...]`, that's
only provided here as some additional information for you), **even if only adding a
"me too" to an existing ticket**:
@@ -162,8 +166,8 @@ only provided here as some additional information for you), **even if only addin
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 contents of your
- terminal tab at the time of the bug occurence, even if you do not have
+ enabled explicitly. Provide at the very least the FULL contents of your
+ terminal tab at the time of the bug occurrence, even if you do not have
a serial.log.]
#### Link to contents of Javascript console in the browser
@@ -177,7 +181,8 @@ only provided here as some additional information for you), **even if only addin
I have read the FAQ.
-Copy-paste this template **completely**. Do not skip any lines!
+Copy-paste this template **completely**. Do not skip any lines or the bot
+*will* complain!
### Where can I find which version and branch I'm on?
@@ -201,15 +206,16 @@ more information is needed.
One is contained in the **"Terminal" tab** within OctoPrint's UI and is a log
of the last 300 lines of communication with the printer. Please copy-paste
-this somewhere (disable auto scroll to make copying the contents easier) -
+this *completely* somewhere (disable auto scroll to make copying the contents easier) -
e.g. http://pastebin.com or http://gist.github.com - and include a link in
your bug report.
There is also **OctoPrint's application log file** or in short `octoprint.log`,
which is by default located at `~/.octoprint/logs/octoprint.log` on Linux,
`%APPDATA%\OctoPrint\logs\octoprint.log` on Windows and
-`~/Library/Application Support/OctoPrint/logs/octoprint.log` on MacOS. Please
-copy-paste this to pastebin or gist as well and include a link in your bug
+`~/Library/Application Support/OctoPrint/logs/octoprint.log` on MacOS. You can
+also access it directly through OctoPrint via Settings > Logs. Please
+copy-paste this *completely* to pastebin or gist as well and include a link in your bug
report.
It might happen that you are asked to provide a more **thorough log of the
@@ -383,6 +389,8 @@ the local version identifier to allow for an exact determination of the active c
* 2016-03-14: Some more requirements for PRs, and a PR template.
* 2016-06-08: New `prerelease` and `rc` branches explained.
* 2016-09-09: New `rc/*` branches explained.
+ * 2016-09-23: Some more work on "How to file a bug report" based on recent
+ experiences
## Footnotes
* [1] - If you are wondering why, the problem is that anything that you add
View
@@ -1,5 +1,4 @@
-OctoPrint
-=========
+# OctoPrint
OctoPrint provides a snappy web interface for controlling a 3D printer (RepRap, Ultimaker, ...). It is Free Software
and released under the [GNU Affero General Public License V3](http://www.gnu.org/licenses/agpl.html).
@@ -22,24 +21,22 @@ might be of more interest for you. You might also want to subscribe to [the mail
or the [G+ Community](https://plus.google.com/communities/102771308349328485741) where there are other active users who might be
able to help you with any questions you might have.
-Contributing
-------------
+## Contributing
Contributions of all kinds are welcome, not only in the form of code but also with regards to the
[official documentation](http://docs.octoprint.org/) or [the public wiki](https://github.com/foosel/OctoPrint/wiki), support
of other users in the [bug tracker](https://github.com/foosel/OctoPrint/issues),
[the Mailinglist](https://groups.google.com/group/octoprint) or
[the G+ Community](https://plus.google.com/communities/102771308349328485741) and also [financially](http://octoprint.org/support-octoprint/).
-If you think something is bad as it is about OctoPrint or its documentation the way it is, please help
+If you think something is bad about OctoPrint or its documentation the way it is, please help
in any way to make it better instead of just complaining about it -- this is an Open Source Project
after all :)
For information about how to go about contributions of any kind, please see the project's
[Contribution Guidelines](https://github.com/foosel/OctoPrint/blob/master/CONTRIBUTING.md).
-Installation
-------------
+## Installation
Installation instructions for installing from source for different operating
systems can be found [on the wiki](https://github.com/foosel/OctoPrint/wiki#assorted-guides).
@@ -66,8 +63,7 @@ releases but also be able to automatically upgrade to them from within
OctoPrint, take a look [at the documentation of the Software Update Plugin](https://github.com/foosel/OctoPrint/wiki/Plugin:-Software-Update#making-octoprint-updateable-on-existing-installations)
and at its settings.
-Dependencies
-------------
+## Dependencies
OctoPrint depends on a couple of python modules to do its job. Those are automatically installed when installing
OctoPrint via `setup.py`:
@@ -78,8 +74,7 @@ You should also do this every time after pulling from the repository, since the
OctoPrint currently only supports Python 2.7.
-Usage
------
+## Usage
Running the `setup.py` script via
@@ -118,8 +113,7 @@ See `octoprint --help` for further information.
OctoPrint also ships with a `run` script in its source directory. You can also invoke that to start up the server, it
takes the same command line arguments as the `octoprint` script.
-Configuration
--------------
+## Configuration
If not specified via the commandline, the configfile `config.yaml` for OctoPrint is expected in the settings folder,
which is located at `~/.octoprint` on Linux, at `%APPDATA%/OctoPrint` on Windows and
@@ -130,9 +124,7 @@ A comprehensive overview of all available configuration settings can be found
Please note that the most commonly used configuration settings can also easily
be edited from OctoPrint's settings dialog.
-Special Thanks
---------------
+## Special Thanks
-The development of OctoPrint is sponsored and maintained by [BQ](http://www.bq.com/).
Cross-browser testing services are kindly provided by [BrowserStack](http://www.browserstack.com/).
Profiling is done with the help of [PyVmMonitor](http://www.pyvmmonitor.com).

0 comments on commit 354042b

Please sign in to comment.