Migrate docs to mono repo (calcom#1814)

* Initial commit Created from https://vercel.com/new * Update config * Homepage * Self-hosting * Integrations * More docs pages * Developer docs * Update billing.mdx * Update install.mdx * Fix install guide * More fixes * Adding CSS guide * Fix capitalisation on Microsoft page * Added delete account update * Added Zapier integration question * Added GMeet integration part * Added Delete Account to Settings * unnecessary question mark * Added a link to Settings * Added stuff in Billing * Added a link to cal.com/signup * Capitalization * Added language change * Added more stuff in Event Types * Added how to change email * Added FAQ page * Spelling mistake * Added a title to FAQ * Added more stuff to Billing * Availability multi-booking * Deleted from Availability added to FAQ * Added to FAQ * Removed the dot * Added stuff to FAQ * Add license warning to adding CSS page * Update docker.mdx * Add import instructions * removed readme until we have our own * updated favicon, added cal sans * added new cal sans * Create README.md * renamed all github links * renamed more github links * Added team's Event Types * Clarified the Google Meet integration * Spelling error * Added primary calendar tutorial * Removed tutorial * primary calendar selection * Moved to subdirectory * Matching configs * Shares eslint config between web and docs * Removes format-schemas * Updates env file location in turbo * [docs] updates monorepo intructions Co-authored-by: baileypumfleet <pumfleet@hey.com> Co-authored-by: Peer Richelsen <peeroke@gmail.com> Co-authored-by: milospuac <97884287+milospuac@users.noreply.github.com> Co-authored-by: Peer Richelsen <peeroke@richelsen.net>
joeauyeung · Feb 11, 2022 · c5444c8 · c5444c8
1 parent 63bd9a1
commit c5444c8
Show file tree

Hide file tree

Showing 69 changed files with 6,987 additions and 91 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
diff --git a/.prettierignore b/.prettierignore
@@ -13,3 +13,4 @@ public
 .prettierignore
 .DS_Store
 .eslintignore
+apps/web/prisma/zod
diff --git a/README.md b/README.md
@@ -166,7 +166,7 @@ yarn dx
 1. Run (in development mode)
 
    ```sh
-   yarn dev
+   yarn dev --scope=@calcom/web
    ```
 
 #### Setting up your first user
@@ -230,14 +230,14 @@ yarn workspace @calcom/web playwright-report
 4. Start the server. In a development environment, just do:
 
    ```sh
-   yarn dev
+   yarn dev --scope=@calcom/web
    ```
 
    For a production build, run for example:
 
    ```sh
-   yarn build
-   yarn start
+   yarn build --scope=@calcom/web
+   yarn start --scope=@calcom/web
    ```
 
 5. Enjoy the new version.

diff --git a/apps/docs/.eslintrc.js b/apps/docs/.eslintrc.js
@@ -0,0 +1 @@
+module.exports = require("@calcom/config/eslint-preset");
diff --git a/apps/docs/.gitignore b/apps/docs/.gitignore
@@ -0,0 +1,7 @@
+node_modules
+.next
+.DS_Store
+yarn-error.log
+dist
+examples
+packages
diff --git a/apps/docs/.nvmrc b/apps/docs/.nvmrc
@@ -0,0 +1 @@
+14.17
diff --git a/apps/docs/.prettierignore b/apps/docs/.prettierignore
@@ -0,0 +1,2 @@
+.next
+node_modules
diff --git a/apps/docs/LICENSE b/apps/docs/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Shu Ding
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/apps/docs/README.md b/apps/docs/README.md
@@ -0,0 +1,75 @@
+<!-- PROJECT LOGO -->
+<div align="right">
+  <a href="https://github.com/calcom/cal.com">
+    <img src="https://user-images.githubusercontent.com/8019099/133430653-24422d2a-3c8d-4052-9ad6-0580597151ee.png" alt="Logo">
+  </a>
+  <a href="https://cal.com">Website</a>
+  ·
+  <a href="https://github.com/calcom/docs/issues">Community Support</a>
+</div>
+
+# Cal.com Documentation
+
+The official product, support and developer documentation, containing information and guides about using the product as well as support for self-hosted installations. This documentation site runs on [Nextra](https://nextra.vercel.app), so you may refer to their documentation should you need information on anything that isn't covered here.
+
+## Prerequisites
+- Git
+- Node.js & npm
+- Yarn
+
+## Installation
+Firstly, clone the repository using Git:
+```console
+git clone https://github.com/calcom/docs.git
+```
+
+Now, you can install the dependencies with yarn:
+```console
+yarn install
+```
+
+## Editing
+To create, edit and delete documentation pages, you can simply create markdown (.mdx) files in the `pages/` folder. You can edit Markdown with any text editor, but VS Code and WebStorm have side-by-side previews so you can see your formatted content whilst writing markdown.
+
+You will also need to add it as an entry to the `meta.json` file found in whichever directory that the .mdx file is in.
+
+## Local Development
+
+```console
+yarn dev
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+## Build
+
+```console
+yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static content hosting service.
+
+## How to easily contribute
+
+## Existing Page
+1. From the documentation's GitHub repository, head to the folder called 'pages' and open it.
+2. From here you can view all current pages on the documentation site. Select the page you would like to contribute to.
+3. You should now be able to view the page you have selected. Located at the top right of the page will be a pencil icon. Pressing this will bring you up an editor to edit and make changes. You can add formatting using the buttons at the top, which will automatically insert the relevant markdown content needed to style the text.
+4. From here make the changes you wish to make.
+5. At the bottom of the screen will be a 'Propose Changes' box, fill in all the relevant details such as title and description then press the green 'Propose Changes' button.
+6. Your changes have been saved, to submit them for review, located on your screen, press the green 'Create Pull Request' button.
+7. Fill in all the relevant details such as title and description and after finalize the submission.
+
+You have now successfully edited and submitted changes to our documentation site.
+
+## Creating a New Page
+
+1. From the documentation's GitHub repository, head to the folder called 'pages' and open it.
+2. From here you can view all current pages on the documentation site. At the top of your screen press the 'New file' button.
+3. You should now be able to view the page you have created. Remember when renaming the document to put .mdx at the end of the file name.
+4. From here make the changes you wish to make. Such as creating a title, sub-title and body text.
+5. At the bottom of the screen will be a 'Propose Changes' box, fill in all the relevant details such as title and description then press the green 'Propose Changes' button.
+6. Your changes have been saved, to submit them for review, located on your screen, press the greem 'Create Pull Request' button.
+7. Fill in all the relevant details such as title and description and after finalize the submission.
+
+You have now successfully created and submitted changes to our documentation site.
diff --git a/apps/docs/next.config.js b/apps/docs/next.config.js
@@ -0,0 +1,6 @@
+const withNextra = require('nextra')({
+  theme: 'nextra-theme-docs',
+  themeConfig: './theme.config.js',
+  unstable_staticImage: true,
+})
+module.exports = withNextra()
diff --git a/apps/docs/package.json b/apps/docs/package.json
@@ -0,0 +1,20 @@
+{
+  "name": "@calcom/docs",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "dev": "next",
+    "start": "next start",
+    "build": "next build"
+  },
+  "author": "Cal.com, Inc.",
+  "license": "MIT",
+  "dependencies": {
+    "next": "^12.0.9",
+    "nextra": "^1.1.0",
+    "nextra-theme-docs": "^1.2.2",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2"
+  }
+}
diff --git a/apps/docs/pages/_app.js b/apps/docs/pages/_app.js
@@ -0,0 +1,6 @@
+import "nextra-theme-docs/style.css";
+import "./style.css";
+
+export default function Nextra({ Component, pageProps }) {
+  return <Component {...pageProps} />;
+}
diff --git a/apps/docs/pages/availability.mdx b/apps/docs/pages/availability.mdx
@@ -0,0 +1,23 @@
+# Availability
+
+## Setting your availability
+
+1. Go to [Your Availability](https://app.cal.com/availability) page within your cal.com account.
+2. On the availability page you can manage your availability to suit your working day accordingly.
+You can also troubleshoot your availability if your calendar does not look like it is blocking out the correct times.
+
+
+## Troubleshooting availability
+
+This will tell you when your calendar shows you as busy, so you can understand why Cal is blocking certain times.
+
+## How to troubleshoot availability
+
+1. Go to [Your Availability](https://app.cal.com/availability).
+2. To the right of your screen a box saying 'Something doesn't look right?' will appear. Press the button 'Launch Troubleshooter'.
+3. After pressing this, your availability will appear according to your calendar and inform you of the times booked up for that day!
+
+By doing this you will know understand why certain times are available and others are blocked.
+
+## In team settings availability set to only Mondays but the calendar shows availability on other days as well
+It’s showing as available on days other than Monday because only you have set your availability to only Mondays, whereas the rest of the team haven't made that setting.
diff --git a/apps/docs/pages/billing.mdx b/apps/docs/pages/billing.mdx
@@ -0,0 +1,33 @@
+# Billing
+## How the trial works
+You are given FREE access for 14 days of our PRO subscription, you can use this to test and try out our product and see if it works for you. No credit card is required to sign up and you decide if you want to upgrade to a PRO subscription afterwards.
+
+## How to cancel the trial
+If you are looking to cancel the trial and want to downgrade to the free option you can contact our support team where we will be happy to help you make that change!
+
+## How to upgrade
+If you are looking at upgrading from our FREE subscription to our PRO subscription, head over to cal.com/upgrade where you can easily upgrade hassle free.
+
+## How to downgrade
+1. Go to your [Billing Settings](https://app.cal.com/settings/billing).
+2. From here you can press the button called `Go to the billing Portal`. That will take you to the page where you can upgrade/downgrade your plan.
+
+## How to delete your account
+You can delete your account from within the [Settings](https://app.cal.com/settings/profile) option. Just scroll all the way down and click on `Delete Account`.
+
+## Purchasing a premium username
+We've reserved a ton of premium usernames, such as short handles or first names to prevent name squatters. To find out if your username is premium, head over to [cal.com/signup](https://cal.com/signup) and choose your desired username. From here you will be taken straight to checkout and after proceeding your Cal.com account will be created with your desired username.
+
+## Manage your subscription
+1. Go to your [Billing Settings](https://app.cal.com/settings/billing).
+2. From here you can press the button called `Go to the billing Portal`.
+3. This will take you to an external site provided by Stripe as they deal with all our payments.
+
+Some users may not be able to access Billing as their billing email is different to their account email. If this is the case, you can change the email associated with your account in [Profile Settings](https://app.cal.com/settings/profile).
+
+## Subscription for each team member
+If your team requires multiple event types then each team member has to be subscribed to our paid plan. If that is something that isn’t necessary for your team, you can proceed with your FREE plan. 
+
+## Discount for non-profits and students
+We offer 50% for non-profit organizations and students. Just raise a ticket with our support team and submit the necessary proof of status.
+
diff --git a/apps/docs/pages/bookings.mdx b/apps/docs/pages/bookings.mdx
@@ -0,0 +1,25 @@
+# Bookings
+
+## What can you do on the bookings page?
+
+On the bookings page you are able to see upcoming and past events booked through your event type links. This page also lets you cancel or reschedule upcoming events users have scheduled.
+
+## How to view bookings
+
+1. Go to [your upcoming and past bookings](https://app.cal.com/bookings/upcoming).
+2. On this page you can see upcoming and past events booked through your event type links.
+
+## Reschedule bookings
+
+1. Go to [your rescheduled bookings](https://app.cal.com/bookings/upcoming).
+2. Hovering over the event you want to reschedule, click the button saying 'Reschedule'
+3. Clicking 'Reschedule' will bring you to your Cal booking page. Select a new Time and Date.
+4. After selecting this you can go ahead and click that 'Reschedule' Button!
+5. After, you and your attendee will receive a new confirmation email of your new date and time.
+
+## Cancel bookings
+
+1. Go to [your cancelled](https://app.cal.com/bookings/cancelled).
+2. Hovering over the event you want to cancel, click the button saying 'Cancel'
+3. Once done, you will receive a confirmation message saying 'Really cancel your booking?'. After confirming you can go ahead and click the red 'Cancel' button at the bottom of your screen.
+4. After, you and your attendee will receive a new confirmation email of your event being cancelled.
diff --git a/apps/docs/pages/developer/adding-css.mdx b/apps/docs/pages/developer/adding-css.mdx
@@ -0,0 +1,33 @@
+import Callout from 'nextra-theme-docs/callout';
+
+# Adding CSS
+
+<Callout>
+  Adding or modifying CSS counts as changing the code, so as per [our license](https://github.com/calcom/cal.com/blob/main/LICENSE) you must either open-source your modified version or purchase an enterprise license.
+</Callout>
+
+Cal.com uses [TailwindCSS](https://tailwindcss.com) as a replacement for traditional CSS styling within the application, but some people prefer to add CSS styles themselves.
+
+CSS files should be stored in the `styles` directory within the codebase.
+
+Within the `styles` directory, you will find two CSS files, `fonts.css` and `global.css`. We suggest not to add to these files, and instead create new CSS files and import them into the application. This helps reduce conflicts when pulling in changes that we've made to either of the existing CSS files.
+
+## Adding new stylesheets
+Firstly, create the CSS file inside the `styles` directory.
+
+Then, open the `pages/_app.tsx` file, and you will see the following two lines:
+```javascript
+import "../styles/fonts.css";
+import "../styles/globals.css";
+```
+
+Duplicate one of these import statements and change the path to link to your new CSS stylesheet, like so:
+```javascript
+import "../styles/your-new-stylesheet.css";
+```
+
+<Callout type="warning" emoji="⚠️">
+  These styles will apply to all pages and components in your application.
+</Callout>
+
+Due to the global nature of stylesheets, and to avoid conflicts, you may **only import them inside `pages/_app.tsx`**.
diff --git a/apps/docs/pages/developer/code-styling.mdx b/apps/docs/pages/developer/code-styling.mdx
@@ -0,0 +1,15 @@
+# Code Styling
+Keeping our code styles consistent is key to making the repository easy to read and work with.
+
+We use a number of style guides written by other amazing companies, simply because they are widely used and because we like working with them.
+
+We don't expect you to study every single rule of each style guide, but these are great reference points as to how your code should be styled. We may reject a pull request if your code style significantly differs from these style guides however.
+
+## ESLint & Prettier
+Calendso uses the ESLint and Prettier formatting tools, and the repository comes with defined rules for each tool. We recommend setting up both tools and using these to help automatically style your code to our guidelines.
+
+## JavaScript/TypeScript
+We use the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) for all JavaScript and Typescript code.
+
+## HTML & CSS
+We use the [Google HTML/CSS Style Guide](https://google.github.io/styleguide/htmlcssguide.html) for any HTML and CSS markup. However, exceptions to the HTML guide apply where JSX differentiates from standard HTML.
diff --git a/apps/docs/pages/developer/meta.json b/apps/docs/pages/developer/meta.json
@@ -0,0 +1,9 @@
+{
+    "migrations": "Migrations",
+    "pre-fill": "Pre-fill fields",
+    "code-styling": "Code styling",
+    "project-structure": "Project structure",
+    "pull-requests": "Pull requests",
+    "adding-css": "Adding CSS"
+  }
+