Merge pull request #165 from poozlehq/164-doc-fixes

Documentation Fix

docs/cloud/getting-started.mdx

@@ -0,0 +1,24 @@
+---
+title: "Getting Started"
+description: "This page guides you through setting up your Oauth, integration account and managing syncs."
+---
+
+## Set up your Poozle Cloud account
+
+We're currently in private beta for cloud. if you early access reachout to us at manik@poozle.dev. Once you get credentials please follow next steps
+
+## Connect your APIs
+
+<CardGroup cols={2}>
+  <Card title="Login" href="/connect-integrations/login" color="#68a063">
+    Login to Dashboard
+  </Card>
+  <Card
+    title="Create Integrations"
+    href="/connect-integrations/api-key"
+    color="#68a063"
+  >
+    Link third-party platforms of end users to Poozle.{" "}
+  </Card>
+
+</CardGroup>

docs/guides/create_integration_account.mdx → docs/connect-integrations/api-key.mdx

@@ -1,10 +1,20 @@
 ---
-title: "Create Account"
+title: "API Key"
+description: "Integration Accounts establish connections for end users. API Key method enables links the app and third-party platforms."
 ---
 
-Integration Accounts represent your end users’ connections between your app and third-party platforms.
-
-## Create a New Integration Account with Poozle UI
+<Tip>
+  {" "}
+  For a more automated approach, consider establishing these connections using our
+  [Create API](/api-reference/integration_account/create_integration_account){" "}
+</Tip>
+
+<Note>
+  {" "}
+  For seamless integration, we recommend using the OAuth approach if third party
+  api providers supports it. If not or you don't have an OAuth app, you can utilize
+  the API Key method.{" "}
+</Note>
 
 1. On the Integrations tab, Click on `+ New Integration Account`:
 

docs/connect-integrations/login.mdx

@@ -0,0 +1,8 @@
+---
+title: "Login to Dashboard"
+description: "Login with your credentials in app.poozle.dev. Once logged in, you will see this dashboard."
+---
+
+<Frame>
+  <img src="/images/cloud/landing.png" />
+</Frame>

docs/connect-integrations/oauth.mdx

@@ -0,0 +1,64 @@
+---
+title: "OAuth"
+description: "Integration Accounts signify end-user connections. OAuth method facilitates links the app and third-party platforms."
+---
+
+<Tip>
+  {" "}
+  For a more automated approach, consider creating OAuth apps using our [Create API](/api-reference/oauth/create_oauth){" "}
+</Tip>
+
+Adding a custom OAuth app requires registration of the application with the API provider to obtain the Client ID and Client Secret. Don't forget to register required scopes with both the API provider and on the OAuth page.
+
+### Create a New OAuth Account
+
+1. On the OAuth tab, Click on `+ New OAuth App`:
+
+<Frame>
+  <img src="/images/oauth/create_oauth.png" />
+</Frame>
+
+2. Choose the integration you want to connect and provide the necessary information.
+
+<Frame>
+  <img src="/images/oauth/sample_oauth.png" />
+</Frame>
+
+3. Enter the client_id, client_secret and scopes according to the integration. Once done you can click on create.
+
+4. Once the OAuth is created it will show in the OAuth page. You can now access repective OAuth in the link page.
+
+### Callback URL
+
+Please add this Callback URL respectively in the respective OAuth app
+Cloud
+
+```
+https://app.poozle.dev/api/v1/oauth/callback
+```
+
+Self Hosted
+
+```
+https://{sub_domain}/api/v1/oauth/callback
+```
+
+## Link
+
+Link is a URL used by end users to establish a connection between the app and third-party platforms
+
+### Create a New Integration Account with Link
+
+1. On the Links tab, Click on `+ New Link`:
+
+<Frame>
+  <img src="/images/integration_account/create_link.png" />
+</Frame>
+
+2. Provide the necessary information and click on Create. Once done you can copy the link URL
+
+<Frame>
+  <img src="/images/integration_account/sample_link.png" />
+</Frame>
+
+3. You can use the copied URL to connect accounts. You may also incorporate a button in your user interface, redirecting users to this URL for connecting with third-party apps.

docs/guides/authentication.mdx → docs/guides/basics/authentication.mdx

@@ -7,6 +7,9 @@ You need to authenticate to access all the APIs of Poozle both internal and unif
 1. Go to `Settings` page from the left bar.
 2. Choose API Keys from the above tabs.
 3. Give the key a name, expiry time and click on generate.
+   <Frame>
+     <img src="/images/basic/create_token.png" />
+   </Frame>
 4. Done!!. Copy the token and use in as a Bearer token while calling the APIs.
 
 ```bash

docs/guides/basics/create_user.mdx

@@ -0,0 +1,29 @@
+---
+title: "Create User"
+---
+
+To create a new user for Poozle login you can follow the steps.
+
+```bash
+docker exec -ti poozle-server sh
+yarn create-user
+```
+
+<Note>Password should contain alphanumeric and special characters</Note>
+
+```
+
+~$ yarn create-user
+yarn run v1.22.19
+$ ts-node prisma/seeds/user.ts
+Server is healthy!
+Enter email: manik@poozle.dev
+Enter password: #######
+Enter firstname: Manik
+Enter lastname: Aggarwal
+User created
+Done in 24.05s.
+
+```
+
+You should get user created as shown above.

docs/guides/basics/managed_syncs.mdx

@@ -0,0 +1,6 @@
+---
+title: "Managed Syncs"
+description: "Offers completely managed data syncs for third-party integrations."
+---
+
+At present, managed synchronization is provided exclusively for the Ticketing model. Plans are underway to extend this feature to accommodate the rest of the data models in the near future.

docs/guides/basics/webhooks.mdx

@@ -0,0 +1,6 @@
+---
+title: "Webhooks"
+description: "Receive real-time data updates from the source."
+---
+
+Webhook support is currently under development and will be available in the near future. Progress on this feature can be tracked via this [Pull Request](https://github.com/poozlehq/poozle/issues/100)

docs/guides/overview.mdx

@@ -6,12 +6,12 @@ description: "Learn about interacting with Poozle's Unified API and third-party
 ## Basics
 
 <CardGroup cols={2}>
-  <Card title="Create User" href="/guides/create_user" color="#68a063">
+  <Card title="Create User" href="/guides/basics/create_user" color="#68a063">
     Create a Poozle login user
   </Card>
   <Card
     title="Authentication"
-    href="/guides/create_integration_account"
+    href="/guides/basics/authentication"
     color="#68a063"
   >
     Create a API Key to connect to Poozle APis{" "}
@@ -23,27 +23,7 @@ description: "Learn about interacting with Poozle's Unified API and third-party
 <CardGroup cols={2}>
   <Card
     title="Build an Integration"
-    href="/guides/build_new_integration"
+    href="/guides/integrations/build_new_integration"
     color="#68a063"> Build your own integration in hours </Card>
 
 </CardGroup>
-
-## Other
-
-<CardGroup cols={2}>
-  <Card
-    title="Create Account"
-    href="/guides/create_integration_account"
-    color="#68a063"> Creating an integration account in UI </Card>
-
-    <Card
-    title="Create Link"
-    href="/guides/create_link"
-    color="#68a063"> Create a link to share with your users </Card>
-
-     <Card
-    title="Add OAuth app"
-    href="/guides/create_oauth"
-    color="#68a063"> Add your OAuth app to Poozle </Card>
-
-</CardGroup>

docs/integrations/overview.mdx

@@ -0,0 +1,84 @@
+---
+title: Supported Integrations
+description: "Supported integrations in all categories"
+---
+
+## Ticketing
+
+<CardGroup cols={3}>
+  <Card
+    title="Github"
+    href="/models/ticketing/integrations/github"
+    color="#0061e6"
+    icon="github"
+  >
+    Integration your app with Github
+  </Card>
+  <Card
+    title="Jira"
+    href="/models/ticketing/integrations/jira"
+    color="#0061e6"
+    icon="jira"
+  >
+    Integration your app with Jira
+  </Card>
+  <Card
+    title="Need a Ticketing Integration"
+    href="https://github.com/poozlehq/poozle/issues/new?assignees=&labels=type%2Fbug%2Cintegration%2Cneeds-triage&projects=&template=issue-connector.yaml&title=Integration+Issue%3A+"
+    color="#0061e6"
+    icon="plus"
+  >
+    Create Issue
+  </Card>
+</CardGroup>
+
+## Documentation
+
+<CardGroup cols={3}>
+
+  <Card
+    title="Notion"
+    href="/models/documentation/integrations/notion"
+    color="#0061e6"
+    icon="book"
+  >
+    Integration your app with Notion
+  </Card>
+  <Card
+    title="Confluence"
+    href="/models/documentation/integrations/confluence"
+    color="#0061e6"
+    icon="confluence"
+  >
+    Integration your app with Confluence
+  </Card>
+    <Card
+    title="Need a Documentation Integration"
+    href="https://github.com/poozlehq/poozle/issues/new?assignees=&labels=type%2Fbug%2Cintegration%2Cneeds-triage&projects=&template=issue-connector.yaml&title=Integration+Issue%3A+"
+    color="#0061e6"
+    icon="plus"
+  >
+    Create Issue
+  </Card>
+</CardGroup>
+
+## Mail
+
+<CardGroup cols={3}>
+  <Card
+    title="Gmail"
+    href="/models/mail/integrations/gmail"
+    color="#0061e6"
+    icon="envelope"
+  >
+    Integration your app with Gmail
+  </Card>
+  <Card
+    title="Need a Mail Integration"
+    href="https://github.com/poozlehq/poozle/issues/new?assignees=&labels=type%2Fbug%2Cintegration%2Cneeds-triage&projects=&template=issue-connector.yaml&title=Integration+Issue%3A+"
+    color="#0061e6"
+    icon="plus"
+  >
+    Create Issue
+  </Card>
+</CardGroup>