Skip to content

Commit 20fb234

Browse files
fix: removed self-host page, fixed inline code bloc for expansion component title (#44)
1 parent 590d3aa commit 20fb234

File tree

10 files changed

+39
-32
lines changed

10 files changed

+39
-32
lines changed

markdoc/tags.js

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ const tags = {
6161
attributes: {
6262
href: { type: String, default: '' },
6363
target: { type: String, default: '_self' },
64-
heading: {type: Boolean, default: false}
64+
heading: { type: Boolean, default: false },
6565
},
6666
render: Link,
6767
},
@@ -74,8 +74,9 @@ const tags = {
7474
collapsedTitle: { type: String },
7575
href: { type: String, default: '' },
7676
addAfter: { type: String, default: '' },
77-
link: { type: String, default: '' },
7877
target: { type: String, default: '_self' },
78+
textColor: { type: String },
79+
content: { type: String, default: '' },
7980
},
8081
render: ExpansionTile,
8182
},
@@ -87,10 +88,10 @@ const tags = {
8788
},
8889
'inline-code': {
8990
attributes: {
90-
textColor: { type: String, default: 'text-[#FFFFFF]'}
91+
textColor: { type: String, default: 'text-[#FFFFFF]' },
9192
},
92-
render: InlineCode
93-
}
93+
render: InlineCode,
94+
},
9495
}
9596

9697
export default tags

src/components/ExpansionTile.jsx

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
import { useState } from 'react'
22
import { Icon } from './Icon'
3+
import { InlineCode } from './Inline-code'
34

45
export function ExpansionTile({
56
children,
67
collapsedTitle,
78
href,
89
addAfter,
9-
link,
1010
target,
11+
textColor,
12+
content,
1113
}) {
1214
const [isExpanded, setIsExpanded] = useState(false)
1315

@@ -43,9 +45,13 @@ export function ExpansionTile({
4345
{addAfter !== '' ? (
4446
<div>
4547
{partBeforeFor}{' '}
46-
<a href={href} target={target}>
47-
{link}
48-
</a>{' '}
48+
{href === '' ? (
49+
<InlineCode textColor={textColor}>{content}</InlineCode>
50+
) : (
51+
<a href={href} target={target}>
52+
{content}
53+
</a>
54+
)}{' '}
4955
{partAfterFor}
5056
</div>
5157
) : (

src/components/Layout.jsx

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,18 @@ const navigation = [
1818
{ title: 'Home', href: '/' },
1919
{ title: 'Quick start', href: '/quick-start' },
2020
{ title: 'Sign up and sign in', href: '/sign-up-sign-in' },
21+
],
22+
},
23+
{
24+
title: 'Self-hosting',
25+
links: [
26+
{ title: 'Docker Compose', href: '/self-hosting/docker-compose' },
27+
{ title: 'Kubernetes', href: '/self-hosting/kubernetes' },
2128
{
22-
title: 'Self-hosting',
23-
href: '/self-hosting/self-hosting',
24-
links: [
25-
{ title: 'Docker Compose', href: '/self-hosting/docker-compose' },
26-
{ title: 'Kubernetes', href: '/self-hosting/kubernetes' },
27-
{ title: 'Instance admin and God Mode', href: '/instance-admin' },
28-
{ title: 'Reset password', href: '/self-hosting/reset-password' },
29-
],
29+
title: 'Instance admin and God Mode',
30+
href: '/self-hosting/instance-admin',
3031
},
32+
{ title: 'Reset password', href: '/self-hosting/reset-password' },
3133
],
3234
},
3335
{
@@ -158,15 +160,15 @@ function Header({ navigation }) {
158160
href="https://discord.com/invite/A92xrEGCge"
159161
className="group"
160162
aria-label="GitHub"
161-
target='_blank'
163+
target="_blank"
162164
>
163165
<DiscordIcon className="h-6 w-6 fill-slate-400 group-hover:fill-slate-500 dark:group-hover:fill-slate-300" />
164166
</Link>
165167
<Link
166168
href="https://github.com/makeplane/plane"
167169
className="group"
168170
aria-label="GitHub"
169-
target='_blank'
171+
target="_blank"
170172
>
171173
<GitHubIcon className="h-6 w-6 fill-slate-400 group-hover:fill-slate-500 dark:group-hover:fill-slate-300" />
172174
</Link>

src/pages/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Plane is a simple, extensible, open source project and product management tool.
1010

1111
{% quick-link title="Quick Start" icon="installation" href="/quick-start" description="Learn how to use Plane and follow the best practices of taking-off." /%}
1212

13-
{% quick-link title="Self-host Plane" icon="presets" href="/self-hosting/self-hosting" description="Run Plane on your computer or development machine." /%}
13+
{% quick-link title="Self-host Plane" icon="presets" href="/self-hosting/docker-compose" description="Run Plane on your computer or development machine." /%}
1414

1515
{% quick-link title="Integrations" icon="plugins" href="/integrations/about" description="Extend Plane with third-party plugins and integrations" /%}
1616

src/pages/quick-start.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ If you prefer to self-host Plane on your own machine, you can do so using
3535
Docker. However, please note that you'll need to add additional configurations
3636
for email, authentication, and storage services. Plane is open-sourced under
3737
Apache-2.0, and currently, we support self-hosting Plane using Docker. For
38-
detailed instructions, please refer to the [self-hosting](/self-hosting) section.
38+
detailed instructions, please refer to the [self-hosting](/self-hosting/docker-compose) section.
3939

4040
{% callout type="note" %}
4141
We are also working on making the self-hosting process smoother by introducing
@@ -49,7 +49,6 @@ configuration, please raise a feature request on our
4949

5050
Our new sign-up and sign-in flows make it easier for Instance admins to identify themselves and unlock security + governance features for their instance. Our Cloud users also enjoy easier sign-ups and sign-ins. See [Sign up and sign in](/sign-up-sign-in) for more.
5151

52-
5352
## Onboarding and Invitation
5453

5554
If you have signed up for the first time, the first step in Plane is to create a
File renamed without changes.
File renamed without changes.

src/pages/sign-up-sign-in.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ There may also be cases where a user IRL is running multiple instances, e.g., wh
3535

3636
![enter-instance-admin-e-mail-existing-instances-self-hosted](https://plane-marketing.s3.ap-south-1.amazonaws.com/plane-assets/docs/enter-instance-admin-e-mail-existing-instances-self-hosted.png)
3737

38-
This screen will help you get set up with an e-mail and a password and get access to {% inline-code textColor="blue" %}God Mode{% /inline-code %} features. [Learn more](/instance-admin)
38+
This screen will help you get set up with an e-mail and a password and get access to {% inline-code textColor="blue" %}God Mode{% /inline-code %} features. [Learn more](/self-hosting/instance-admin)
3939

40-
To prevent misuse of these features, you can’t access these screens without going through our secure set-up first, which will start when when you upgrade to {% inline-code textColor="red" %}v0.14{% /inline-code %}.
40+
To prevent misuse of these features, you can’t access these screens without going through our secure set-up first, which will start when when you upgrade to {% inline-code textColor="grey" %}v0.14{% /inline-code %}.
4141

4242
{% callout type="cloud" %}
4343
Cloud users will get their own set of {% inline-code textColor="blue" %}God Mode{% /inline-code %} in a later update for authorization and billing controls. {% link href="https://ece39166.sibforms.com/serve/MUIFANgaMWIARsq1n0lMNrch19pdY2HJm9FkSXAeq1DrCoXJBmO9Yq6SPgtzu7rL0lQBmCvvz2A2arVl5WaDxYu6YhNW4PKNAis0DMXmpRnwm5633BvXqIYILqZuyqYiGS7_QjJ0Ozh4R2uctd8RwiiTLSHWpnV2njQt6DPV5cVr8FH3K-TouNAlBScOJxbCpjj8fYo2ULsEJeAL" target="_blank" %}Subscribe to be notified{% /link %}.
@@ -53,7 +53,7 @@ New instances that complete set-up let you skip {% inline-code textColor="blue"
5353

5454
## FAQs
5555

56-
{% expansion collapsedTitle="How do you know who an `Instance admin` is?" %}
56+
{% expansion collapsedTitle="How do you know who an is?" content="Instance admin" addAfter="an" textColor="blue" %}
5757

5858
Whoever spins up the instance or upgrades to {% inline-code textColor="grey" %}v0.14{% /inline-code %}, we assume, is the instance admin. When you see {% inline-code textColor="blue" %}Let's secure your instance{% /inline-code %}, enter your email-password combo. If you are already using Plane with those credentials, you will be logged in and will see {% inline-code textColor="blue" %}/god-mode{% /inline-code %} features. If not, we will create a new user on your local instance and you will see {% inline-code textColor="blue" %}/god-mode{% /inline-code %}.
5959

@@ -75,15 +75,15 @@ All existing users will log in with their usual email address-password combos if
7575

7676
{% /expansion %}
7777

78-
{% expansion collapsedTitle="What will happen to the default `[email protected]` account that you shipped so far?" %}
78+
{% expansion collapsedTitle="What will happen to the default account that you shipped so far?" content="[email protected]" addAfter="default" textColor="blue" %}
7979

8080
For all new instances, there won’t be a {% inline-code textColor="blue" %}[email protected]{% /inline-code %} account. Instance set-up will allow you to set up a workspace and set workspace and project admins.
8181

8282
For existing instances, the instance admin’s email will be added to each project with the same permissions as {% inline-code textColor="blue" %}[email protected]{% /inline-code %}’s so you can remove that email completely from your workspaces and projects.
8383

8484
{% /expansion %}
8585

86-
{% expansion collapsedTitle="This is unreal, but I have an instance that has a `/god-mode` path already. I can’t access my Plane instance. Help!" %}
86+
{% expansion collapsedTitle="This is unreal, but I have an instance that has a path already. I can’t access my Plane instance. Help!" content="/god-mode" textColor="blue" addAfter=" a " %}
8787

8888
That is unreal! Please reach out to us immediately on
8989
{% link href="https://discord.com/login?redirect_to=%2Fchannels%2F1031547764020084846%2F1094927053867995176" target="_blank" %}support{% /link %}
@@ -105,17 +105,17 @@ if you haven’t set up SMTP and are facing troubles with your users logging in.
105105

106106
{% /expansion %}
107107

108-
{% expansion collapsedTitle="Why are you introducing passwords for users? What’s happening with unique links to sign up and sign in?" link="app.plane.so" href="http://app.plane.so" addAfter="for" target="_blank" %}
108+
{% expansion collapsedTitle="Why are you introducing passwords for users? What’s happening with unique links to sign up and sign in?" content="app.plane.so" href="http://app.plane.so" addAfter="for" target="_blank" %}
109109

110110
Unique links are secure and relatively easier, but we have heard from enough of our Cloud users that they would like to log in using a more permanent and easier method. Should you want to continue using unique codes, you are covered. We will keep that option alive for good.
111111

112112
While using Google or GitHub are good options already, not all of you would want to use them. For those that prefer a password and would like to do away with codes, we want to make that option available.
113113

114114
{% /expansion %}
115115

116-
{% expansion collapsedTitle="Is there a `God Mode` for Cloud admins, too?" %}
116+
{% expansion collapsedTitle="Is there a for Cloud admins, too?" content="God Mode" addAfter=" a " textColor="blue" %}
117117

118-
Not now, but soon enough, there will be a {% inline-code textColor="blue" %}God Mode{% /inline-code %} for Cloud admins. More [here](/instance-admin)
118+
Not now, but soon enough, there will be a {% inline-code textColor="blue" %}God Mode{% /inline-code %} for Cloud admins. More [here](/self-hosting/instance-admin)
119119

120120
{% /expansion %}
121121

src/pages/sitemap.xml.jsx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
const pages = [
22
'',
33
'/quick-start',
4-
'/self-hosting',
54
'/docker-compose',
65
'/kubernetes',
76
'/workspaces',

src/pages/workspaces.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ On cloud, here's how you can invite a user to your workspace,
5757

5858
{% callout type="note" %}
5959
Self-hosted users should configure an email service in order to send
60-
invitations. Follow [this](/self-hosting) document to learn how to set up
60+
invitations. Follow [this](/self-hosting/docker-compose) document to learn how to set up
6161
self-hosted instances.
6262
{% /callout %}
6363

0 commit comments

Comments
 (0)