From ee661b0a9fa5a8c3af43e8875a0ab7e2921932bf Mon Sep 17 00:00:00 2001 From: Will Date: Tue, 14 May 2019 20:30:17 -0700 Subject: [PATCH] [Docs] Add release notes for major functionality changes and instructions (#2668) * Add release notes for major functionality changes and instructions * Update docs/changelog_3_1_0.rst Co-Authored-By: Michael H --- docs/changelog_3_1_0.rst | 37 +++++++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/docs/changelog_3_1_0.rst b/docs/changelog_3_1_0.rst index 78581f100..3727e27d1 100644 --- a/docs/changelog_3_1_0.rst +++ b/docs/changelog_3_1_0.rst @@ -1,8 +1,41 @@ .. v3.1.0 Changelog -================ +#################### +v3.1.0 Release Notes +#################### + +---------------------- +Mongo Driver Migration +---------------------- + +Due to the required changes of the Mongo driver for Config, all existing Mongo users will need to +complete the below instructions to continue to use Mongo after updating to 3.1. +This includes **all** users, regardless of any prior migration attempt to a development version of +3.1. + + #. Upgrade to 3.1 + #. Convert all existing Mongo instances to JSON using the new converters + #. Start each bot instance while using JSON and load any and all cogs you have in order to successfully preserve data. + #. Turn each instance off and convert back to Mongo. + **NOTE:** No data is wiped from your Mongo database when converting to JSON. + You may want to use a *new* database name when converting back to Mongo in order to not have duplicate data. + +------------- +Setup Utility +------------- + +New commands were introduced to simplify the conversion/editing/removal process both on our end and the users end. +Please use ``redbot-setup --help`` to learn how to use the new features. + +.. HINT:: + + Converting to JSON: ``redbot-setup convert json`` + + Converting to Mongo: ``redbot-setup convert mongo`` + +################ v3.1.0 Changelog -================ +################ ----- Audio