diff --git a/docs/installation/upgrading.md b/docs/installation/upgrading.md index c13582e96..477848d70 100644 --- a/docs/installation/upgrading.md +++ b/docs/installation/upgrading.md @@ -1,3 +1,7 @@ +# Review the Release Notes + +Prior to upgrading your NetBox instance, be sure to carefully review all [release notes](../release-notes/) that have been published since your current version was released. Although the upgrade process typically does not require additional involvement, certain releases may introduce breaking or backward-incompatible changes. These are called out in the release notes under the version in which the change went into effect. + # Install the Latest Code As with the initial installation, you can upgrade NetBox by either downloading the latest release package or by cloning the `master` branch of the git repository. diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md new file mode 100644 index 000000000..d9c0bfd1c --- /dev/null +++ b/docs/release-notes/index.md @@ -0,0 +1,3 @@ +# NetBox Release Notes + +Select the desired version from the menu at left. diff --git a/mkdocs.yml b/mkdocs.yml index ea66cfee9..b03f357fe 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -12,24 +12,6 @@ pages: - 4. LDAP (Optional): 'installation/4-ldap.md' - Upgrading NetBox: 'installation/upgrading.md' - Migrating to Python3: 'installation/migrating-to-python3.md' - - Release Notes: - - Version 2.6: 'release-notes/version-2.6.md' - - Version 2.5: 'release-notes/version-2.5.md' - - Version 2.4: 'release-notes/version-2.4.md' - - Version 2.3: 'release-notes/version-2.3.md' - - Version 2.2: 'release-notes/version-2.2.md' - - Version 2.1: 'release-notes/version-2.1.md' - - Version 2.0: 'release-notes/version-2.0.md' - - Version 1.9: 'release-notes/version-1.9.md' - - Version 1.8: 'release-notes/version-1.8.md' - - Version 1.7: 'release-notes/version-1.7.md' - - Version 1.6: 'release-notes/version-1.6.md' - - Version 1.5: 'release-notes/version-1.5.md' - - Version 1.4: 'release-notes/version-1.4.md' - - Version 1.3: 'release-notes/version-1.3.md' - - Version 1.2: 'release-notes/version-1.2.md' - - Version 1.1: 'release-notes/version-1.1.md' - - Version 1.0: 'release-notes/version-1.0.md' - Configuration: - Configuring NetBox: 'configuration/index.md' - Required Settings: 'configuration/required-settings.md' @@ -71,6 +53,24 @@ pages: - Utility Views: 'development/utility-views.md' - Extending Models: 'development/extending-models.md' - Release Checklist: 'development/release-checklist.md' + - Release Notes: + - Version 2.6: 'release-notes/version-2.6.md' + - Version 2.5: 'release-notes/version-2.5.md' + - Version 2.4: 'release-notes/version-2.4.md' + - Version 2.3: 'release-notes/version-2.3.md' + - Version 2.2: 'release-notes/version-2.2.md' + - Version 2.1: 'release-notes/version-2.1.md' + - Version 2.0: 'release-notes/version-2.0.md' + - Version 1.9: 'release-notes/version-1.9.md' + - Version 1.8: 'release-notes/version-1.8.md' + - Version 1.7: 'release-notes/version-1.7.md' + - Version 1.6: 'release-notes/version-1.6.md' + - Version 1.5: 'release-notes/version-1.5.md' + - Version 1.4: 'release-notes/version-1.4.md' + - Version 1.3: 'release-notes/version-1.3.md' + - Version 1.2: 'release-notes/version-1.2.md' + - Version 1.1: 'release-notes/version-1.1.md' + - Version 1.0: 'release-notes/version-1.0.md' markdown_extensions: - admonition: