Add boilerplate for documenting an upgrade guide (#1873)

pylint-dev · Nov 15, 2022 · e316932 · e316932
1 parent 669b8e0
commit e316932
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/doc/upgrade_guide.rst 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
@@ -8,4 +8,5 @@ The "Changelog" contains *all* nontrivial changes to astroid for the current ver
 .. toctree::
    :maxdepth: 2
 
+   upgrade_guide
    changelog