Merge pull request #49 from makeplane/preview

sriramveeraghanta · web-flow · commit f1b53b0cc73a · 2023-12-13T17:57:45.000+05:30
Promote: Preview to Master
diff --git a/markdoc/tags.js b/markdoc/tags.js
@@ -61,7 +61,7 @@ const tags = {
     attributes: {
       href: { type: String, default: '' },
       target: { type: String, default: '_self' },
-      heading: {type: Boolean, default: false}
+      heading: { type: Boolean, default: false },
     },
     render: Link,
   },
@@ -74,8 +74,9 @@ const tags = {
       collapsedTitle: { type: String },
       href: { type: String, default: '' },
       addAfter: { type: String, default: '' },
-      link: { type: String, default: '' },
       target: { type: String, default: '_self' },
+      textColor: { type: String },
+      content: { type: String, default: '' },
     },
     render: ExpansionTile,
   },
@@ -87,10 +88,10 @@ const tags = {
   },
   'inline-code': {
     attributes: {
-      textColor: { type: String, default: 'text-[#FFFFFF]'}
+      textColor: { type: String, default: 'text-[#FFFFFF]' },
     },
-    render: InlineCode
-  }
+    render: InlineCode,
+  },
 }
 
 export default tags
diff --git a/src/components/ExpansionTile.jsx b/src/components/ExpansionTile.jsx
@@ -1,13 +1,15 @@
 import { useState } from 'react'
 import { Icon } from './Icon'
+import { InlineCode } from './Inline-code'
 
 export function ExpansionTile({
   children,
   collapsedTitle,
   href,
   addAfter,
-  link,
   target,
+  textColor,
+  content,
 }) {
   const [isExpanded, setIsExpanded] = useState(false)
 
@@ -43,17 +45,21 @@ export function ExpansionTile({
           {addAfter !== '' ? (
             <div>
               {partBeforeFor}{' '}
-              <a href={href} target={target}>
-                {link}
-              </a>{' '}
+              {href === '' ? (
+                <InlineCode textColor={textColor}>{content}</InlineCode>
+              ) : (
+                <a href={href} target={target}>
+                  {content}
+                </a>
+              )}{' '}
               {partAfterFor}
             </div>
           ) : (
             collapsedTitle
           )}
         </div>
       </div>
-      {isExpanded && children}
+      <div className="pl-6">{isExpanded && children}</div>
     </div>
   )
 }
diff --git a/src/components/Layout.jsx b/src/components/Layout.jsx
@@ -18,16 +18,18 @@ const navigation = [
       { title: 'Home', href: '/' },
       { title: 'Quick start', href: '/quick-start' },
       { title: 'Sign up and sign in', href: '/sign-up-sign-in' },
+    ],
+  },
+  {
+    title: 'Self-hosting',
+    links: [
+      { title: 'Docker Compose', href: '/self-hosting/docker-compose' },
+      { title: 'Kubernetes', href: '/self-hosting/kubernetes' },
       {
-        title: 'Self-hosting',
-        href: '/self-hosting/self-hosting',
-        links: [
-          { title: 'Docker Compose', href: '/self-hosting/docker-compose' },
-          { title: 'Kubernetes', href: '/self-hosting/kubernetes' },
-          { title: 'Instance admin and God Mode', href: '/instance-admin' },
-          { title: 'Reset password', href: '/self-hosting/reset-password' },
-        ],
+        title: 'Instance admin and God Mode',
+        href: '/self-hosting/instance-admin',
       },
+      { title: 'Reset password', href: '/self-hosting/reset-password' },
     ],
   },
   {
@@ -158,15 +160,15 @@ function Header({ navigation }) {
           href="https://discord.com/invite/A92xrEGCge"
           className="group"
           aria-label="GitHub"
-          target='_blank'
+          target="_blank"
         >
           <DiscordIcon className="h-6 w-6 fill-slate-400 group-hover:fill-slate-500 dark:group-hover:fill-slate-300" />
         </Link>
         <Link
           href="https://github.com/makeplane/plane"
           className="group"
           aria-label="GitHub"
-          target='_blank'
+          target="_blank"
         >
           <GitHubIcon className="h-6 w-6 fill-slate-400 group-hover:fill-slate-500 dark:group-hover:fill-slate-300" />
         </Link>
diff --git a/src/components/link.jsx b/src/components/link.jsx
@@ -1,11 +1,11 @@
-import clsx from "clsx"
+import clsx from 'clsx'
 
 function Link({ children, href = '', target = '_self', heading }) {
   return (
     <a
       href={href}
       target={target}
-      className={heading !== null ? 'text-xl' : ''}
+      className={heading !== null && heading === true ? 'text-xl' : ''}
     >
       {children}
     </a>
diff --git a/src/pages/index.md b/src/pages/index.md
@@ -10,7 +10,7 @@ Plane is a simple, extensible, open source project and product management tool.
 
 {% quick-link title="Quick Start" icon="installation" href="/quick-start" description="Learn how to use Plane and follow the best practices of taking-off." /%}
 
-{% quick-link title="Self-host Plane" icon="presets" href="/self-hosting" description="Run Plane on your computer or development machine." /%}
+{% quick-link title="Self-host Plane" icon="presets" href="/self-hosting/docker-compose" description="Run Plane on your computer or development machine." /%}
 
 {% quick-link title="Integrations" icon="plugins" href="/integrations/about" description="Extend Plane with third-party plugins and integrations" /%}
 
diff --git a/src/pages/quick-start.md b/src/pages/quick-start.md
@@ -35,7 +35,7 @@ If you prefer to self-host Plane on your own machine, you can do so using
 Docker. However, please note that you'll need to add additional configurations
 for email, authentication, and storage services. Plane is open-sourced under
 Apache-2.0, and currently, we support self-hosting Plane using Docker. For
-detailed instructions, please refer to the [self-hosting](/self-hosting) section.
+detailed instructions, please refer to the [self-hosting](/self-hosting/docker-compose) section.
 
 {% callout type="note" %}
 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
 
 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.
 
-
 ## Onboarding and Invitation
 
 If you have signed up for the first time, the first step in Plane is to create a
diff --git a/src/pages/removed/self-hosting.md b/src/pages/removed/self-hosting.md
diff --git a/src/pages/self-hosting/docker-compose.md b/src/pages/self-hosting/docker-compose.md
@@ -16,7 +16,7 @@ Let's get started!
 
 {% expansion collapsedTitle="Option 1 - Using Cloud Server" %}
 
-Best way to start is to create EC2 maching on AWS. It must of minimum `t3.medium/t3a.medium`
+Best way to start is to create EC2 machine on AWS. It must of minimum `t3.medium/t3a.medium`
 
 Run the below command to install docker engine.
 
diff --git a/src/pages/self-hosting/instance-admin.md b/src/pages/self-hosting/instance-admin.md
diff --git a/src/pages/self-hosting/reset-password.md b/src/pages/self-hosting/reset-password.md
@@ -8,21 +8,21 @@ Users can reset their password through the terminal of the Plane Application. Yo
 
 1.  Get the container id for `plane-backend`
 
-```jsx
-docker ps
-```
+    ```jsx
+    docker ps
+    ```
 
-1. Log in to the container
+2. Log in to the container
 
-```jsx
-docker exec -it <container_id> /bin/sh
-```
+    ```jsx
+    docker exec -it <container_id> /bin/sh
+    ```
 
-1. Run the reset password command
+3. Run the reset password command
 
-```jsx
-python manage.py reset_password <email>
-```
+    ```jsx
+    python manage.py reset_password <email>
+    ```
 
 {% callout type="note" %}
 The email should be of an already existing user on the Plane application. If the email is not attached to any user the command will throw an error.
diff --git a/src/pages/sign-up-sign-in.md b/src/pages/sign-up-sign-in.md
@@ -35,14 +35,14 @@ There may also be cases where a user IRL is running multiple instances, e.g., wh
 
 ![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)
 
-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)
+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)
 
-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 %}.
+To prevent misuse of these features, you can’t access these screens without going through our secure set-up first, which will start when you upgrade to {% inline-code textColor="grey" %}v0.14{% /inline-code %}.
 
 {% callout type="cloud" %}
-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. Subscribe to be notified.
+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 %}.
 {% /callout %}
-
+f
 Completing set-up will lead you to a success screen that should look like ↓.
 
 ![success-on-setup-existing-instances-self-hosted](https://plane-marketing.s3.ap-south-1.amazonaws.com/plane-assets/docs/success-on-setup-existing-instances-self-hosted.png)
@@ -53,7 +53,7 @@ New instances that complete set-up let you skip {% inline-code textColor="blue"
 
 ## FAQs
 
-{% expansion collapsedTitle="How do you know who an `Instance admin` is?" %}
+{% expansion collapsedTitle="How do you know who an is?" content="Instance admin" addAfter="an" textColor="blue" %}
 
 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 %}.
 
@@ -75,15 +75,15 @@ All existing users will log in with their usual email address-password combos if
 
 {% /expansion %}
 
-{% expansion collapsedTitle="What will happen to the default `captain@plane.so` account that you shipped so far?" %}
+{% expansion collapsedTitle="What will happen to the default account that you shipped so far?" content="captain@plane.so" addAfter="default" textColor="blue" %}
 
 For all new instances, there won’t be a {% inline-code textColor="blue" %}captain@plane.so{% /inline-code %} account. Instance set-up will allow you to set up a workspace and set workspace and project admins.
 
 For existing instances, the instance admin’s email will be added to each project with the same permissions as {% inline-code textColor="blue" %}captain@plane.so{% /inline-code %}’s so you can remove that email completely from your workspaces and projects.
 
 {% /expansion %}
 
-{% 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!" %}
+{% 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 " %}
 
 That is unreal! Please reach out to us immediately on
 {% 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.
 
 {% /expansion %}
 
-{% 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" %}
+{% 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" %}
 
 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.
 
 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.
 
 {% /expansion %}
 
-{% expansion collapsedTitle="Is there a `God Mode` for Cloud admins, too?" %}
+{% expansion collapsedTitle="Is there a for Cloud admins, too?" content="God Mode" addAfter=" a " textColor="blue" %}
 
-Not now, but soon enough, there will be a {% inline-code textColor="blue" %}God Mode{% /inline-code %} for Cloud admins. More [here](/instance-admin)
+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)
 
 {% /expansion %}
 
diff --git a/src/pages/sitemap.xml.jsx b/src/pages/sitemap.xml.jsx
@@ -1,7 +1,6 @@
 const pages = [
   '',
   '/quick-start',
-  '/self-hosting',
   '/docker-compose',
   '/kubernetes',
   '/workspaces',
diff --git a/src/pages/workspaces.md b/src/pages/workspaces.md
@@ -57,7 +57,7 @@ On cloud, here's how you can invite a user to your workspace,
 
 {% callout type="note" %}
 Self-hosted users should configure an email service in order to send
-invitations. Follow [this](/self-hosting) document to learn how to set up
+invitations. Follow [this](/self-hosting/docker-compose) document to learn how to set up
 self-hosted instances.
 {% /callout %}
 
