Skip to content

Commit 1ed7f54

Browse files
Dancia ClaraDancia Clara
authored andcommitted
minor fixes
1 parent 257bc07 commit 1ed7f54

File tree

6 files changed

+35
-29
lines changed

6 files changed

+35
-29
lines changed

mint.json

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,12 +86,13 @@
8686
"pages": [
8787
"self-hosting/manage/backup-restore",
8888
"self-hosting/manage/upgrade-plane",
89-
"self-hosting/manage/view-logs",
90-
"self-hosting/manage/prime-cli"
89+
"self-hosting/upgrade-from-community",
90+
"self-hosting/activate-license",
91+
"self-hosting/manage/prime-cli",
92+
"self-hosting/manage/view-logs"
93+
9194
]
92-
},
93-
"self-hosting/upgrade-from-community",
94-
"self-hosting/activate-license"
95+
}
9596
]
9697
},
9798
{

self-hosting/activate-license.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
---
22
title: Activate License
3-
sidebarTitle: Activate License
3+
sidebarTitle: Activate license
44
---
55

66
If you are on the Community edition and want to upgrade to a paid plan, see [Upgrade from Community](/self-hosting/manage-plans/upgrade-from-community).
77

8-
To upgrade to a paid plan on the Enterprise edition, follow the steps below:
8+
To activate the license of a paid plan on the Enterprise edition, follow the steps below:
99

1010
1. Login to the [Plane Prime](https://prime.plane.so) portal.
11-
2. If you don't already have the license, choose the [paid plan](https://takeoff.prime.plane.tools/licenses/plans) you want to purchase.
12-
3. Go to [Manage licenses](https://takeoff.prime.plane.tools/licenses). Copy the value of **Passkey** on the license you want to activate.
11+
2. If you haven't purchased the license already, choose the [paid plan](https://prime.plane.so/licenses/plans) you want.
12+
3. Go to [Manage licenses](https://prime.plane.so/licenses). Copy the value of the **Passkey** for the license you want to activate.
1313
<Frame>![Create issue](/images/upgrade-to-paid-plan/manage-licenses.webp)</Frame>
14-
5. Click the ⌄ icon next to your workspace name on the sidebar at the top and click **Workspace Settings**.
14+
5. On the Plane app, click the ⌄ icon next to your workspace name on the sidebar and select **Workspace Settings**.
1515
<Frame>![Create issue](/images/upgrade-to-paid-plan/workspace-settings.webp)</Frame>
1616
3. Select **Activation** on the right pane.
1717
<Frame>![Create issue](/images/upgrade-to-paid-plan/activate-license-key.webp)</Frame>
18-
4. Paste the license key you copied from step 3 in the **Enter license key** box on the right pane.
19-
5. Click the **Activate** button to activate your instance with the paid plan.
18+
4. Paste the passkey you copied in the **Enter license key** box on the right pane.
19+
5. Click the **Activate** button to activate your workspace with the paid plan.
2020
<Frame>![Create issue](/images/upgrade-to-paid-plan/license-activate-one.webp)</Frame>
21-
6. You can manage your subscription in the **Billing and plans** tab under **Workspace Settings**.
21+
6. You can view the activated plan and renewal date, and manage the subscription in the **Billing and plans** tab under **Workspace Settings**.
2222
<Frame>![Create issue](/images/upgrade-to-paid-plan/billing-plane-one.webp)</Frame>
2323

2424

self-hosting/manage/backup-restore.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Backup and restore data
3-
sidebarTitle: Backup and Restore
3+
sidebarTitle: Backup and restore data
44
---
55

66
## Backup data

self-hosting/manage/upgrade-plane.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Update Plane
2+
title: Update Plane version
33
---
44

55
This page provides steps to update Plane to the latest version on your self-hosted instance.

self-hosting/methods/docker-compose.mdx

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Docker
55
This guide shows you the steps to deploy a self-hosted instance of Plane using Docker.
66

77
## Enterprise edition
8-
To install the Enterprise edition (Plane One and Plane Pro), follow the steps below:
8+
This section shows you how to install the Enterprise edition (Plane One and Plane Pro). If you want to install the Community edition, see [Community edition](#community-edition).
99

1010
### Prerequisites
1111

@@ -33,16 +33,18 @@ To install the Enterprise edition (Plane One and Plane Pro), follow the steps be
3333
7. If you want to activate the license for a paid plan, see [Activate License](/self-hosting/activate-license).
3434

3535
## Community edition
36-
To install the Community edition, follow the steps below:
36+
To install the free Community edition, follow the steps below:
3737

3838
### Prerequisites
3939

4040
- Docker installed and running. Choose one of the following options:
41-
- **Option 1**: Create an EC2 machine on AWS. It must of minimum **t3.medium/t3a.medium**. Run the below command to install docker engine.
42-
```bash
43-
curl -fsSL https://get.docker.com | sh -
44-
```
45-
- **Option 2**: Install [Docker Desktop](https://www.docker.com/products/docker-desktop/).
41+
- **Option 1**
42+
Create an EC2 machine on AWS. It must of minimum **t3.medium/t3a.medium**. Run the below command to install docker engine.
43+
```bash
44+
curl -fsSL https://get.docker.com | sh -
45+
```
46+
- **Option 2**
47+
Install [Docker Desktop](https://www.docker.com/products/docker-desktop/).
4648
- OS with bash scripting enabled (Ubuntu, Linux AMI, macos). Windows systems need to have [gitbash](https://git-scm.com/download/win).
4749
- User context used must have access to docker services. In most cases, use `sudo su` to switch as root user.
4850
- Use the terminal (or gitbash) window to run all the future steps.
@@ -79,7 +81,7 @@ To install the Enterprise edition (Plane One and Plane Pro), follow the steps be
7981
```bash
8082
./setup.sh
8183
```
82-
This will prompt you with the below options.
84+
This will prompt you with the below options.
8385
```list
8486
Select a Action you want to perform:
8587
1) Install (arm64)
@@ -93,7 +95,7 @@ To install the Enterprise edition (Plane One and Plane Pro), follow the steps be
9395
Action [2]: 1
9496
```
9597
6. Enter `1` as input.
96-
This will create a folder `plane-app` or `plane-app-preview` (in case of preview deployment) and will download the `docker-compose.yaml` and `.env` files.
98+
This will create a folder `plane-app` or `plane-app-preview` (in case of preview deployment) and will download the `docker-compose.yaml` and `plane.env` files.
9799
7. Enter `8` to exit.
98100
8. Set up the environment variables. You can use any text editor to edit this file. Below are the most importants keys you must refer to:
99101
- `NGINX_PORT`: This is set to `80` by default. Make sure the port you choose to use is not preoccupied. For example, `NGINX_PORT=8080`
@@ -103,18 +105,18 @@ To install the Enterprise edition (Plane One and Plane Pro), follow the steps be
103105
```bash
104106
./setup.sh
105107
```
106-
10. Enter `2` as input to to start the services.
108+
10. Enter `2` as input to start the services.
107109
You will something like this:
108110
![Downloading docker images](/images/docker-compose/download-docker.png)
109111
Be patient as it might take some time based on your download speed and system configuration. If all goes well, you must see something like this:
110112
![Downloading completed](/images/docker-compose/download-complete.png)
111113
This is the confirmation that all images were downloaded and the services are up and running.
112114

113-
You have successfully self-hosted the `Plane` instance. Access the application by going to IP or domain you have configured it on. For example, `https://plane.example.com:8080` or `http://[IP-ADDRESS]:8080`.
115+
You have successfully self-hosted the Plane instance. Access the application by going to IP or domain you have configured it on. For example, `https://plane.example.com:8080` or `http://[IP-ADDRESS]:8080`.
114116

115117
#### Stop server
116118

117-
In case you want to make changes to `.env` variables, we recommend that you stop the services before doing that.
119+
In case you want to make changes to the environment variables in the `plane.env` file, we recommend that you stop the services before doing that.
118120

119121
Run the `./setup.sh` command. Enter `3` to stop the services.
120122

@@ -124,7 +126,7 @@ To install the Enterprise edition (Plane One and Plane Pro), follow the steps be
124126

125127
#### Restart server
126128

127-
In case you want to make changes to `.env` variables without stopping the server or noticed some abnormalities in services, you can restart the services.
129+
In case you want to make changes to `plane.env` variables without stopping the server or noticed some abnormalities in services, you can restart the services.
128130

129131
Run the `./setup.sh` command. Enter `4` to restart the services.
130132

self-hosting/methods/kubernetes.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Kubernetes
55
This guide shows you the steps to deploy a self-hosted instance of Plane using Kubernetes.
66

77
## Enterprise edition
8-
To install Plane, follow the steps below:
8+
This section shows you how to install the Enterprise edition (Plane One and Plane Pro). If you want to install the Community edition, see [Community edition](#community-edition).
99

1010
### Prerequisites
1111

@@ -247,6 +247,9 @@ To install Plane, follow the steps below:
247247
</AccordionGroup>
248248

249249
## Community edition
250+
251+
To install the free Community edition, follow the steps below:
252+
250253
### Prerequisites
251254

252255
- A working Kubernetes cluster

0 commit comments

Comments
 (0)