Merge pull request #10 from makeplane/update-installation

Update installation

Author: danciaclara

mint.json

@@ -26,7 +26,7 @@
   },
   "anchors": [
     {
-      "name": "Documentation",
+      "name": "Plane Documentation",
       "icon": "book",
       "url": "https://docs.plane.so/"
     },
@@ -92,11 +92,11 @@
         {
           "group" : "Manage instance",
           "pages": [
-            "self-hosting/manage/backup-restore",
-            "self-hosting/manage/upgrade-plane",
             "self-hosting/upgrade-from-community",
+            "self-hosting/manage/upgrade-plane",
             "self-hosting/manage/prime-cli",
-            "self-hosting/manage/view-logs"
+            "self-hosting/manage/view-logs",
+            "self-hosting/manage/backup-restore"
 
           ]
         },

self-hosting/manage/backup-restore.mdx

@@ -1,6 +1,6 @@
 ---
-title: Backup and restore data
-sidebarTitle: Backup and restore data
+title: Backup and restore data on Community edition
+sidebarTitle: Community backup and restore
 ---
 
 ## Backup data

self-hosting/methods/docker-compose.mdx

@@ -4,7 +4,7 @@ title: Docker
 
 This guide shows you the steps to deploy a self-hosted instance of Plane using Docker.
 
-## Recommended edition
+## Install Plane
 Plane One and Plane Pro are enabled on this edition, so the Free plan on this edition is easier to trial our paid plans from.
 
 ### Prerequisites
@@ -17,7 +17,11 @@ Plane One and Plane Pro are enabled on this edition, so the Free plan on this ed
       - CentOS
       - Amazon Linux 2 or Linux 2023
 
-### Installation
+### Procedure
+
+   <Tip>
+   If you want to upgrade from Community to the Commercial edition, see [Upgrade from Community](/self-hosting/upgrade-from-community).
+   </Tip>
 
    1. `ssh` into your machine as the root user (or user with sudo access) per the norms of your hosting provider.
    2. Run the command below:  
@@ -30,10 +34,13 @@ Plane One and Plane Pro are enabled on this edition, so the Free plan on this ed
       - **Express**: Plane installs with the default configurations.
       - **Advanced**: You can customize the database, Redis, storage  and other settings.
    6. The installation will take a few minutes to complete and you will see the message **Plane has successfully installed**. You can access the Plane application on the domain you provided during the installation. 
-   7. If you want to upgrade to a paid plan, see [Plan upgrades](https://docs.plane.so/workspaces-and-users/upgrade-plan).
+   
+<Tip>
+If you want to upgrade to a paid plan, see [Plan upgrades](https://docs.plane.so/workspaces-and-users/upgrade-plan).
+</Tip>
 
-## Community Edition 
-   To install our Community Edition, please follow these steps below.
+<Accordion title="Install Community Edition ">
+  The Commercial edition comes with a free plan and the flexibility to upgrade to a paid plan at any point. If you still want to install the Community edition, follow the steps below:
 
    ### Prerequisites
 
@@ -131,4 +138,5 @@ Plane One and Plane Pro are enabled on this edition, so the Free plan on this ed
          Run the `./setup.sh` command. Enter `4` to restart the services.
 
          If all goes well, you will see something like this:
-         ![Restart Services](/images/docker-compose/restart-docker.png)
+         ![Restart Services](/images/docker-compose/restart-docker.png)
+</Accordion>

self-hosting/methods/kubernetes.mdx

@@ -4,15 +4,18 @@ title: Kubernetes
 
 This guide shows you the steps to deploy a self-hosted instance of Plane using Kubernetes.
 
-## Recommended edition
+## Install Plane
 Plane One and Plane Pro are enabled on this edition, so the Free plan on this edition is easier to trial our paid plans from.
 
 ### Prerequisites
 
     - A working Kubernetes cluster
     - `kubectl` and `helm` on the client system that you will use to install our Helm charts
 
-### Installation
+### Procedure
+    <Tip>
+     If you want to upgrade from Community to the Commercial edition, see [Upgrade from Community](/self-hosting/upgrade-from-community).
+    </Tip>
 
     1. Open terminal or any other command-line app that has access to Kubernetes tools on your local system.
     2. Set the following environment variables:
@@ -87,10 +90,11 @@ Plane One and Plane Pro are enabled on this edition, so the Free plan on this ed
                     --wait \
                     --wait-for-jobs 
             ```
-    5. If you want to upgrade to a paid plan, see [Plan upgrades](https://docs.plane.so/workspaces-and-users/upgrade-plan).
+<Tip>
+If you want to upgrade to a paid plan, see [Plan upgrades](https://docs.plane.so/workspaces-and-users/upgrade-plan).
+</Tip>
 
-<AccordionGroup>
-   <Accordion title="Configuration settings">
+### Configuration settings
 
     #### License
 
@@ -245,13 +249,24 @@ Plane One and Plane Pro are enabled on this edition, so the Free plan on this ed
     |---|:---:|:---:|---|
     | env.storageClass | longhorn |  | Creating the persitant volumes for the stateful deployments needs the `storageClass` name. Set the correct value as per your kubernetes cluster configuration. |
     | env.secret_key | 60gp0byfz2dvffa45cxl20p1scy9xbpf6d8c5y0geejgkyp1b5 | Yes | This must be a random string which is used for hashing/encrypting the sensitive data within the application. Once set, changing this might impact the already hashed/encrypted data|
-    
-</Accordion>
-</AccordionGroup>
-  
-## Community Edition
 
-To install our Community Edition, please follow these steps below.
+## Custom Ingress Routes
+
+    If you are planning to use 3rd party ingress providers, here is the available route configuration
+
+    | Host | Path | Service |
+    |---    |:---:|---|
+    | plane.example.com | `/` | `<http://plane-app-web.plane:3000>` |
+    | plane.example.com | `/spaces/*`  | `<http://plane-app-space.plane:3000>` |
+    | plane.example.com | `/god-mode/*` | `<http://plane-app-admin.plane:3000>` |
+    | plane.example.com | `/live/*` | `<http://plane-app-live.plane:3000>` |
+    | plane.example.com | `/api/*`  |  `<http://plane-app-api.plane:8000>` |
+    | plane.example.com | `/auth/*` | `<http://plane-app-api.plane:8000>` |
+    | plane.example.com | `/uploads/*` | `<http://plane-app-minio.plane:9000>` |
+    | plane-minio.example.com | `/` | `<http://plane-app-minio.plane:9090>` |
+  
+<Accordion title="Install Community Edition ">
+  The Commercial edition comes with a free plan and the flexibility to upgrade to a paid plan at any point. If you still want to install the Community edition, follow the steps below:
 
     ### Prerequisites
 
@@ -321,8 +336,7 @@ To install our Community Edition, please follow these steps below.
                     --wait-for-jobs 
                 ```
 
-<AccordionGroup>
-  <Accordion title="Configuration settings">
+    ### Configuration settings
 
         #### Plane Version
 
@@ -450,22 +464,4 @@ To install our Community Edition, please follow these steps below.
         | Setting | Default | Required | Description |
         |---|:---:|:---:|---|
         | env.secret_key | 60gp0byfz2dvffa45cxl20p1scy9xbpf6d8c5y0geejgkyp1b5 | Yes | This must be a random string that is used for hashing/encrypting the sensitive data within the application. Once set, changing this might impact the already hashed/encrypted data|
-
-    </Accordion>
-</AccordionGroup>
-
-
-## Custom Ingress Routes
-
-    If you are planning to use 3rd party ingress providers, here is the available route configuration
-
-    | Host | Path | Service |
-    |---    |:---:|---|
-    | plane.example.com | `/` | `<http://plane-app-web.plane:3000>` |
-    | plane.example.com | `/spaces/*`  | `<http://plane-app-space.plane:3000>` |
-    | plane.example.com | `/god-mode/*` | `<http://plane-app-admin.plane:3000>` |
-    | plane.example.com | `/live/*` | `<http://plane-app-live.plane:3000>` |
-    | plane.example.com | `/api/*`  |  `<http://plane-app-api.plane:8000>` |
-    | plane.example.com | `/auth/*` | `<http://plane-app-api.plane:8000>` |
-    | plane.example.com | `/uploads/*` | `<http://plane-app-minio.plane:9000>` |
-    | plane-minio.example.com | `/` | `<http://plane-app-minio.plane:9090>` |
+</Accordion>