From e3169329d3cd175d50a0eea2439dd4f7df4f46aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dani=C3=ABl=20van=20Noord?= <13665637+DanielNoord@users.noreply.github.com> Date: Tue, 15 Nov 2022 23:35:32 +0100 Subject: [PATCH] Add boilerplate for documenting an upgrade guide (#1873) --- doc/upgrade_guide.rst | 11 +++++++++++ doc/whatsnew.rst | 1 + 2 files changed, 12 insertions(+) create mode 100644 doc/upgrade_guide.rst diff --git a/doc/upgrade_guide.rst b/doc/upgrade_guide.rst new file mode 100644 index 000000000..79c57496f --- /dev/null +++ b/doc/upgrade_guide.rst @@ -0,0 +1,11 @@ +=============== +Upgrade guide +=============== + +To ease the transition between major releases, the following page describes some of the breaking +changes between major release and what to change to safely upgrade. + +Upgrading from ``astroid`` ``2.x`` to ``3.0`` +--------------------------------------------- + +- Work in progress diff --git a/doc/whatsnew.rst b/doc/whatsnew.rst index e26a3c7b5..b30ebc4fb 100644 --- a/doc/whatsnew.rst +++ b/doc/whatsnew.rst @@ -8,4 +8,5 @@ The "Changelog" contains *all* nontrivial changes to astroid for the current ver .. toctree:: :maxdepth: 2 + upgrade_guide changelog