Move upgrade guide to docs

Author: axelrindle

docs/docusaurus.config.js

@@ -36,10 +36,7 @@ const config = {
       ({
         docs: {
           sidebarPath: require.resolve('./sidebars.js'),
-          // Please change this to your repo.
-          // Remove this to remove the "edit this page" links.
-          editUrl:
-            'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
+          editUrl: 'https://github.com/axelrindle/github-version-checker/tree/main/docs',
         },
         blog: false,
         theme: {
@@ -65,6 +62,15 @@ const config = {
             sidebarPath: require.resolve('./sidebars.js'),
         },
     ],
+    [
+        '@docusaurus/plugin-content-docs',
+        {
+            id: 'upgrading',
+            path: 'upgrading',
+            routeBasePath: 'upgrading',
+            sidebarPath: require.resolve('./sidebars.js'),
+        },
+    ],
     [
         '@docusaurus/plugin-content-docs',
         {
@@ -102,18 +108,37 @@ const config = {
             position: 'left',
             label: 'Documentation',
           },
+          {
+            type: 'doc',
+            docId: 'index',
+            position: 'left',
+            label: 'Upgrading',
+            docsPluginId: 'upgrading',
+          },
           {
             type: 'doc',
             docId: 'index',
             position: 'left',
             label: 'Examples',
-            docsPluginId: 'examples'
+            docsPluginId: 'examples',
+          },
+          {
+            type: 'doc',
+            docId: 'index',
+            position: 'left',
+            label: 'Changelog',
+            docsPluginId: 'changelog',
           },
           {
             href: 'https://github.com/axelrindle/github-version-checker',
             label: 'GitHub',
             position: 'right',
           },
+          {
+            href: 'https://www.npmjs.com/package/github-version-checker',
+            label: 'npm',
+            position: 'right',
+          },
         ],
       },
       footer: {

MIGRATING-TO-2.0.0.md docs/upgrading/2.0.0.mdMIGRATING-TO-2.0.0.md renamed to docs/upgrading/2.0.0.md

@@ -1,8 +1,13 @@
+---
+sidebar_position: 1
+sidebar_label: ➡️ 2.0.0
+---
+
 # Migrating to Version `2.0.0`
 
 Please note the following changes, when you migrate from a version below `2.0.0`:
 
 - The `options` object changed and requires using a [personal access token](https://blog.github.com/2013-05-16-personal-api-tokens/). See [here](https://github.com/axelrindle/github-version-checker#the-options-object).
 - The `callback` structure changed. I decided to apply a node convention called **Error-First** in which a callback function's first parameter is the `error`. See [here](https://github.com/axelrindle/github-version-checker#the-callback-function-optional).
 
-Before opening an issue, please confirm that you changed your code according to these changes.
+Before opening an issue, please confirm that you changed your code according to these changes.

docs/upgrading/index.md

@@ -0,0 +1,24 @@
+---
+sidebar_position: 0
+sidebar_label: Start
+---
+
+# Upgrading
+
+This section contains for handling major version upgrades.
+
+Following the [Semantic Versioning](https://semver.org/) convention, a major upgrade is an *incompatible API changes*.
+This includes the following changes (examples):
+
+- Supported Node.js versions
+- Removing deprecated APIs
+- Breaking changes in terms of functionality
+
+I didn't quite adhere to this convention in the past but will definetely do in the future.
+
+:::caution
+Make sure your environment supports a major upgrade of dependencies.
+:::
+
+Also consider a look into the [Changelog](https://github.com/axelrindle/github-version-checker/blob/main/CHANGELOG.md)
+which states important changes for each release.