From 1e7be4598cec1afae9f3843a3bb760c5840c7c5d Mon Sep 17 00:00:00 2001 From: Eric Callahan Date: Tue, 21 Feb 2023 16:54:29 -0500 Subject: [PATCH] docs: add a changelog Signed-off-by: Eric Callahan --- docs/changelog.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 11 ++++--- 2 files changed, 81 insertions(+), 6 deletions(-) create mode 100644 docs/changelog.md diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 0000000..deeaf2e --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1,76 @@ +# Changelog + +All notable changes to this project will be documented in this file. +Notable changes prior to 2023-02-01 may be found in [user_changes.md] and +[api_changes.md]. + +The format is based on [Keep a Changelog]. + +## [Unreleased] + +### Added + +- Added this changelog! +- **sensor**: New component for generic sensor configuration. + - [Configuration Docs](configuration.md#sensor) + - [API Docs](web_api.md#sensor-apis) + - [Websocket Notification Docs](web_api.md#sensor-events) +- **file_manager**: Added new [scan metadata](web_api.md#scan-gcode-metadata) endpoint. +- **file_manager**: Added new [thumbnails](web_api.md#get-gcode-thumbnails) endpoint. +- **file_manager**: Added [file_system_observer](configuration.md#file_manager) + configuration option. +- **file_manager**: Added [enable_observer_warnings](configuration.md#file_manager) + configuration option. +- **file_manager**: Added ability to upload to symbolic links. +- **metadata**: Added support for Simplify3D V5 metadata parsing +- **machine**: Added [shutdown_action](configuration.md#machine) configuration + option. +- **machine**: Added service detection to the `supervisord_cli` provider. +- **machine**: Added `octoeverywhere` to the list of default allowed service. +- **power**: Added support for "Hue" device groups. +- **websockets**: Added support for [direct bridge](web_api.md#bridge-websocket) + connections. +- **update_manager**: Added new [refresh](web_api.md#refresh-update-status) endpoint. +- **update_manager**: Added support for pinned pip upgrades. +- **websockets**: Added support for post connection authentication over the websocket. +- **scripts**: Added database backup and restore scripts. + +### Changed + +- **file_manager**: Improved inotify synchronization with API requests. +- **file_manager**: Endpoint return values are now consistent with their + respective websocket notifications. +- **machine**: The [provider](configuration.md#machine) configuration option + now expects `supervisord_cli` instead of `supervisord`. +- **update_manager**: Relaxed requirement for git repo tag detection. Now only two + parts are required (ie: v1.5 and v1.5.0 are acceptable). + +### Deprecated + +- **file_manager**: The `enable_inotify_warnings` configuration option has been + deprecated in favor of `enable_observer_warnings`. + +### Fixed + +- **file_manager**: Fix edge condition where `create_file` notifications + may be sent before a `create_dir` notification. +- **power** - Fixed URL encoding issues for http devices. +- **template**: A ConfigError is now raised when a template fails to + render during configuration. +- **machine**: Fixed support for Supervisord Version 4 and above. +- **update_manager**: Added package resolution step to the APT backend. +- **update_manger**: Fixed PackageKit resolution step for 64-bit systems. + +## [0.7.1] - 2021-07-08 + +- Experimental pre-release + + +[keep a changelog]: https://keepachangelog.com/en/1.0.0/ +[semantic versioning]: https://semver.org/spec/v2.0.0.html +[user_changes.md]: user_changes.md +[api_changes.md]: api_changes.md + + +[unreleased]: https://github.com/Arksine/moonraker/compare/v0.7.1...HEAD +[0.7.1]: https://github.com/Arksine/moonraker/releases/tag/v0.7.1 \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 309db2e..f0e4fd7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,14 +5,13 @@ nav: - 'User Documentation': - Installation: installation.md - Configuration : configuration.md - - User Changes: user_changes.md - - 'Client Developers': - - Client API: web_api.md + - 'Developer Documenation': + - Remote API: web_api.md - Printer Objects: printer_objects.md - - API Changes: api_changes.md - - 'Backend Developers': - - Contributing: contributing.md - Components: components.md + - 'Miscellaneous': + - Contributing: contributing.md + - Changelog: changelog.md theme: name: readthedocs plugins: