Merge pull request #118 from makeplane/new-selfhosting-layout

Updated the Self-hosting section

Author: srinivaspendem

images/activate-license/activate-pro-license.webp

@@ -40,10 +40,6 @@
     {
       "name": "API Reference",
       "url": "api-reference"
-    },
-    {
-      "name": "Plane One",
-      "url":"plane-one"
     }
   ],
   "navigation": [
@@ -59,23 +55,43 @@
       "pages": [
         "self-hosting/overview",
         {
-          "group":"Methods",
+          "group":"Install Plane",
           "pages":[
           "self-hosting/methods/docker-compose",
           "self-hosting/methods/kubernetes"
           ]
         },
         {
-          "group" : "Govern",
+          "group" : "Configure instance",
           "pages": [
             "self-hosting/govern/instance-admin",
-            "self-hosting/govern/authentication",
+            {
+              "group": "Authentication",
+              "pages": [
+                "self-hosting/govern/authentication",
+                "self-hosting/govern/google-oauth",
+                "self-hosting/govern/github-oauth",
+                "self-hosting/govern/oidc-sso",
+                "self-hosting/govern/saml-sso"
+              ]
+            },
             "self-hosting/govern/communication",
             "self-hosting/govern/custom-domain",
-            "self-hosting/govern/reset-password"
+            "self-hosting/govern/reset-password",
+            "self-hosting/telemetry"
           ]
         },
-        "self-hosting/telemetry"
+        {
+          "group" : "Manage instance",
+          "pages": [
+            "self-hosting/manage/backup-restore",
+            "self-hosting/manage/upgrade-plane",
+            "self-hosting/upgrade-from-community",
+            "self-hosting/manage/prime-cli",
+            "self-hosting/manage/view-logs"
+            
+          ]
+        }
       ]
     },
     {
@@ -128,6 +144,13 @@
         "core-concepts/power-k"
       ]
     },
+    {
+      "group": "Workspaces and users",
+      "pages": [
+        "self-hosting/billing-and-plans",
+        "self-hosting/upgrade-plan"
+      ]
+    },
     {
       "group": "Integrations",
       "pages": [
@@ -274,45 +297,6 @@
     {
       "group": "Webhooks",
       "pages": ["webhooks/intro-webhooks"]
-    },
-    {
-      "group": "Plane One",
-      "pages":[
-        "plane-one/introduction"
-      ]
-    },
-    {
-      "group": "Self-host",
-      "pages":[
-        "plane-one/self-host/overview",
-        {
-          "group":"Methods",
-          "pages":[
-            "plane-one/self-host/methods/docker",
-            "plane-one/self-host/methods/kubernetes"
-            
-          ]
-        }
-      ]
-    },
-    {
-      "group": "Manage",
-      "pages":[
-        "plane-one/manage/prime-cli",
-        "plane-one/manage/prime-client"
-      ]
-    }, 
-    {
-      "group": "Govern",
-      "pages":[
-        {
-          "group":"Authentication",
-          "pages":[
-            "plane-one/governance/authentication/custom-sso"
-          ]
-        },
-        "plane-one/governance/workspaces-and-teams"
-      ]
     }
   ],
   "footerSocials": {
@@ -479,6 +463,18 @@
     {
       "source": "/plane-one/self-host/methods/one-command",
       "destination": "/plane-one/self-host/methods/docker"
+    },
+    {
+      "source": "/plane-one/self-host/methods/docker",
+      "destination": "/self-hosting/methods/docker-compose"
+    },
+    {
+      "source": "/plane-one/self-host/methods/kubernetes",
+      "destination": "/self-hosting/methods/kubernetes"
+    },
+    {
+      "source": "/plane-one/self-host/overview",
+      "destination": "/self-hosting/overview"
     }
   ],
   "analytics": {

images/activate-license/billing-and-plans-cloud.webp

@@ -0,0 +1,73 @@
+---
+title: Billing and plans
+sidebarTitle: Billing and plans
+---
+
+At Plane, we aim to provide flexible billing options to cater to the diverse needs of our users. This page outlines our billing and refund policies for both cloud and self-hosted users.
+
+Once you upgrade to a paid plan on either cloud or self-hosted instances, billing will apply based on the number of seats for users with **Admin** or **Member** roles in the workspace.
+
+## Monthly billing
+
+You will be charged for the number of active seats (Y) with **Admin** or **Member** roles in your workspace every month.
+
+### Add new users
+
+If you add new users (N) during the month, the N additional seats will be charged immediately and Y seats will be charged at the end of the current billing cycle. At the end of the current billing cycle, the total seats for the next billing cycle will be updated to Y + N.
+
+### Remove users
+
+If users are removed from the workspace, there will be no charges or immediate refunds for the removed seats. The unused seats will be prorated and adjusted in the next billing cycle.
+
+### Change in user roles
+
+If roles are changed during the billing cycle, new roles requiring **Admin** or **Member** seats will be charged immediately. 
+
+### Downgrade plan
+
+Seats will be available till the end of the current billing cycle. Post the billing cycle, you have the option to cancel or downgrade the plan.
+
+### End Subscription
+
+#### Cloud
+- For workspaces with less than 12 members, the paid plan will remain active until the end of the billing cycle, after which you can cancel the subscription or downgrade your plan.
+- If you have more than 12 members and choose to cancel, access to the product will be locked. Workspace admins will see a modal prompting to either manage members or upgrade to the paid plan.
+
+#### Self-hosted
+
+The paid plan will remain active until the end of the billing cycle, after which you can cancel the subscription or downgrade your plan.
+
+## Yearly billing
+
+You will be charged for the number of active seats (Y) with **Admin** or **Member** roles in your workspace every year. For workspaces with more than 100 users, Plane offers the option to sign a custom contract, including dedicated support and tailored billing arrangements. Please reach out to our sales team for more information.
+
+### Add new users
+
+If new users are added during the year, the seats will be charged on a prorated basis for the remaining billing cycle immediately.
+
+### Remove users
+
+No immediate charges or refunds for removed users. Instead, the seats will be charged on a prorated basis on your next billing cycle.
+
+### Change in user roles
+
+No immediate charges or refunds for changes in user roles. Instead, the seats will be charged on a prorated basis on your next billing cycle.
+
+### Downgrade plan
+
+Seats will be available till the end of the current billing cycle. Post the billing cycle, you have the option to cancel or downgrade the plan.
+
+### End Subscription
+
+#### Cloud
+- For workspaces with less than 12 members, the paid plan will remain active until the end of the billing cycle, after which you can cancel the subscription or downgrade your plan.
+- If you have more than 12 members and choose to cancel, access to the product will be locked. Admins will see a modal prompting them to either manage members or upgrade to the paid plan.
+
+#### Self-hosted
+The paid plan will remain active until the end of the billing cycle, after which you can cancel the subscription or downgrade your plan.
+
+## Refunds
+
+Plane generally does not offer refunds. Charges are applied at the beginning of each billing cycle, and changes in team size or member roles are handled through prorated adjustments in the next cycle, as detailed above. For annual plans, no refunds are issued for unused seats; however, seats can continue to be used until the end of the current billing cycle.
+
+If you experience any issues with billing or wish to discuss special circumstances, feel free to contact our support team for assistance.

images/activate-license/copy-license-key.webp

@@ -1,5 +1,5 @@
 ---
-title : Authentication
+title : Overview
 description: Plane offers several methods you can choose from to let your users log in to your Plane instance. Configure these methods in `Authentication` on `/god-mode` of your instance.
 ---
 {/* ## Restrict sign-ups to invited users
@@ -15,69 +15,3 @@ Plane lets your users log in with codes sent over email. This is disabled if SMT
 ### Passwords
 
 Your users can log in with passwords that they or you set for them. This is toggled on when SMTP isn't configured for your instance. Disable it if you would like to use another authentication method below.
-
-### Google OAuth
-
-Plane already ships with out-of-the-box support for Google OAuth. This is the easiest option to configure for Google Workspace users.
-
-#### Configure Plane as an app on Google API Console
-
-First, you will need to identify Plane as an approved OAuth app to Google.
-
-1. Go to the [Google API console](https://console.cloud.google.com/apis) and create a new project.
-2. Navigate to the **OAuth consent screen** under **APIs & Services**. Choose how you want to configure and register the Plane app, including your target users, and click **Create**.
-   <Frame>![](/images/authentication/google/google-auth-1.png)</Frame>
-3. Configure the OAuth consent screen with information about the app.
-   <Frame>![](/images/authentication/google/google-auth-2.png)</Frame>
-4. Navigate to the **Credentials** screen, click **Create Credentials**, and select **OAuth client ID** from the options given.
-   <Frame>![](/images/authentication/google/google-auth-3.png)</Frame>
-5. Select **Web application** under the **Application type** dropdown list. Update the following fields.
-   1. **Authorized JavaScript origins**\
-      The HTTP origins that host your web application, e.g., `https://app.plane.so`
-   2. **Authorized redirect URIs**\
-      Append the path that users should be redirected to after they have authenticated with Google, e.g., `https://app.plane.so/auth/google/callback`
-   3. Click **Create**.
-   4. Get the Client ID and Client secret under **OAuth 2.0 Client IDs** on the **Credentials** screen.
-   <Frame>![](/images/authentication/google/google-auth-4.png)</Frame>
-
-#### Configure Plane
-
-1. Go to `Google` on the Authentication screen of `/god mode`.
-2. Add the client ID + the client secret from Google API Console.
-3. Click `Save `.
-<Frame>![](/images/instance-admin/authentication-instance-settings.png)</Frame>
-
-
-Your Plane instance should now work with `Sign in with Google`.
-
-
-<Note>We don't restrict domains in with Google OAuth yet. It's on our roadmap.</Note>
-
-## Github OAuth
-
-Plane also supports GitHub OAuth so your users can sign-in with GitHub instead.
-
-### Configure Plane as an OAuth app on GitHub
-
-1. Log in to your [GitHub account](https://github.com/).
-2. Click your profile's avatar and navigate to **Settings.**
-3. Click **Developer Settings** and then **OAuth Apps**.
-   <Frame>![](/images/authentication/github/github-auth-1.png)</Frame>
-4. Click **Register a new application**.
-5. Configure the following OAuth credentials for your Plane app.
-   1. **Homepage URL**\
-      The domain, with HTTPS, on which you host Plane, e.g., `https://app.plane.so`
-   2. **Authorization Callback URL**\
-      Append `/auth/github/callback/ `to the Homepage URL, e.g., `https://app.plane.so//auth/github/callback/`
-6. Click `Register application` to save it.
-   <Frame>![](/images/authentication/github/github-auth-2.png)</Frame>
-7. Find the app you just registered and click through to find the client ID and the client secret. You will need this for the next steps.
-
-### Configure Plane
-
-1. Go to `GitHub` on the Authentication screen of `/god mode`.
-2. Add the client ID + the client secret from the GitHub app you just registered.
-3. Click `Save `.
-<Frame>![](/images/instance-admin/authentication-instance-settings.png)</Frame>
-
-Your Plane instance should now work with GitHub sign-in.

images/activate-license/enter-license-key-selfhosted.webp

@@ -0,0 +1,30 @@
+---
+title: Github OAuth
+---
+
+Plane also supports GitHub OAuth so your users can sign-in with GitHub instead.
+
+## Configure Plane as an OAuth app on GitHub
+
+1. Log in to your [GitHub account](https://github.com/).
+2. Click your profile's avatar and navigate to **Settings.**
+3. Click **Developer Settings** and then **OAuth Apps**.
+   <Frame>![](/images/authentication/github/github-auth-1.png)</Frame>
+4. Click **Register a new application**.
+5. Configure the following OAuth credentials for your Plane app.
+   1. **Homepage URL**\
+      The domain, with HTTPS, on which you host Plane, e.g., `https://app.plane.so`
+   2. **Authorization Callback URL**\
+      Append `/auth/github/callback/ `to the Homepage URL, e.g., `https://app.plane.so//auth/github/callback/`
+6. Click `Register application` to save it.
+   <Frame>![](/images/authentication/github/github-auth-2.png)</Frame>
+7. Find the app you just registered and click through to find the client ID and the client secret. You will need this for the next steps.
+
+## Configure Plane
+
+1. Go to `GitHub` on the Authentication screen of `/god mode`.
+2. Add the client ID + the client secret from the GitHub app you just registered.
+3. Click `Save `.
+<Frame>![](/images/instance-admin/authentication-instance-settings.png)</Frame>
+
+Your Plane instance should now work with GitHub sign-in.