diff --git a/docs/index.rst b/docs/index.rst index 8f0030739..0227887ce 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -79,6 +79,7 @@ How to Guides entry-points setuptools + upgrade-guides support-multiple-versions Conceptual Guides diff --git a/docs/upgrade-guides.md b/docs/upgrade-guides.md new file mode 100644 index 000000000..01da3f9df --- /dev/null +++ b/docs/upgrade-guides.md @@ -0,0 +1,34 @@ +# Upgrade Guides + +```{contents} +:depth: 1 +:local: true +``` + +## Upgrading 8.3.X to 9.0 +**This is under active construction and will not be finalized until 9.0.0 is released.** + +This guide assumes the user is on version 8.3.X. + +### Deprecations + +For each deprecation, provide a brief explanation, and direct users to new function / class if available. +- TBD + +### Removals with prior deprecation + +For each removal, provide a brief explanation, and direct users to new function / class if available. If possible, deprecate and remove in 10.0.0, rather than removing outright. +- TBD + +### Removals with no prior deprecation + +The changes were not able to be deprecated prior to removal. Explain clearly why then were not able to be deprecated first. +- TBD + +### Changes + +- TBD + +### Fixes + +- TBD