From 1f68e9b75873ab20b04da6ab921ae8921bfb6e91 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 13 Dec 2024 13:40:10 +0000 Subject: [PATCH 1/2] Documentation edits made through Mintlify web editor --- development.mdx | 151 +++++++++++++++++++++++++++--------------------- test.mdx | 28 ++++----- 2 files changed, 97 insertions(+), 82 deletions(-) diff --git a/development.mdx b/development.mdx index 8783008..72155cc 100644 --- a/development.mdx +++ b/development.mdx @@ -1,98 +1,117 @@ --- -title: 'Development' -description: 'Learn how to preview changes locally' +title: "Create a Project" --- - - **Prerequisite** You should have installed Node.js (version 18.10.0 or - higher). - +# -Step 1. Install Mintlify on your OS: +## Roles: Manager | Partner - + + + -```bash npm -npm i -g mintlify -``` +You can create a new project right after adding your cloud credentials! During project creation, you have the option to specify various settings and configurations to suit your needs. -```bash yarn -yarn global add mintlify -``` +### Steps to Create a New Project - + + + + Open the Projects menu in the Taikun CloudWorks platform. + -Step 2. Go to the docs are located (where you can find `mint.json`) and run the following command: + + Locate and click the **Add Project** button in the top right corner. + -```bash -mintlify dev -``` + + Enter a name for your project and select a **Cloud** provider in the pop-up. + + -The documentation website is now available at `http://localhost:3000`. + + Profiles for **Access**, **Alerting**, **Kubernetes**, and **Policy** are initially set to default. Custom profiles need to be created in advance before using them in your projects. + + -### Custom Ports + + Certain features in Taikun CloudWorks, such as **Alerting Profiles**, **Monitoring**, **Backup**, and **Expiration Dates**, can be configured or enabled after the project is created. + -Mintlify uses port 3000 by default. You can use the `--port` flag to customize the port Mintlify runs on. For example, use this command to run in port 3333: +*** -```bash -mintlify dev --port 3333 -``` +*** -You will see an error like this if you try to run Mintlify in a port that's already taken: + + If you intend to use a specific **Access Profile** in your project, create it *before* starting the project creation process. This profile can then be selected from the drop-down menu during project creation. + -```md -Error: listen EADDRINUSE: address already in use :::3000 -``` +*** -## Mintlify Versions +*** -Each CLI is linked to a specific version of Mintlify. Please update the CLI if your local website looks different than production. +### Project Details - +* **Project Name**: Enter a unique name for your project. Only lowercase alphanumeric characters and dashes are allowed (3-30 characters; no underscores). Example: `my-project1` -```bash npm -npm i -g mintlify@latest -``` +* **Cloud**: Select where to store your project. For instructions on connecting a new cloud, see [Cloud Credentials](#cloud-credentials). -```bash yarn -yarn global upgrade mintlify -``` +#### Optional Settings - +* **Kubernetes Version**: Choose a specific Kubernetes version, if needed. -## Deployment +* **CIDR**: Specify a network or sub-network if required. - - Unlimited editors available under the [Startup - Plan](https://mintlify.com/pricing) - +* **Access Profile**: Choose a profile for project access. (For setup instructions, see [Access Profiles](#access-profiles)). -You should see the following if the deploy successfully went through: +* **Alerting Profile**: Select an alerting profile from the dropdown if already created. - - - +* **Kubernetes Profile**: Choose a profile after creating it in Kubernetes Profiles. + + * **For OpenStack**: If you choose a profile with an enabled Taikun Load Balancer, you’ll need to configure the **Taikun Load Balancer Flavor**, **Router Id Start Range**, and **Router Id End Range**. + +* **Policy Profile**: Select a policy profile for this project. + +* **Monitoring**: Enables monitoring of Kubernetes clusters to help manage containerized infrastructure, track resource utilization (memory, CPU, storage). + +* **Backup**: Choose backup credentials, or create new ones in [Backup Credentials](#backup-credentials). You can change this later if needed. + +* **Expiration Date**: Set a project expiration date. By default, this is set to infinity. Note: Projects remain unaffected after the expiration date. + +* **Serverless**: Enable serverless options to manage events and triggers. DNS setup is required. + +* **Spot Features**: Enable spot features (AWS, Azure, Google supported). + + * **Allow Spot VMs**: Enable spots for standalone VMs. + + * **Allow Full Spot Kubernetes**: Enable full spot for Kubernetes. + + * **Allow Spot Workers**: Enable spots for workers only. + + * **No Spot for Kubernetes**: Disable spots for Kubernetes. + +* **Flavor**: Bind specific flavors to the project. Multiple flavors can be added and managed in **Flavor Info**. + +#### Autoscaler Configuration + +Enable autoscaling by specifying server parameters: + +* **Name**: Define a name for the server. + +* **Minimum Workers**: Set the minimum number of workers. + +* **Maximum Workers**: Set the maximum number of workers. -## Troubleshooting +* **Disk Size**: Define disk size. -Here's how to solve some common problems when working with the CLI. +* **Flavor**: Select a flavor for the server. - - - Update to Node v18. Run `mintlify install` and try again. - - -Go to the `C:/Users/Username/.mintlify/` directory and remove the `mint` -folder. Then Open the Git Bash in this location and run `git clone -https://github.com/mintlify/mint.git`. +*** -Repeat step 3. +## Additional Resources - - - Try navigating to the root of your device and delete the ~/.mintlify folder. - Then run `mintlify dev` again. - - +For a comprehensive understanding of the project creation process, watch our instructional video below: -Curious about what changed in a CLI version? [Check out the CLI changelog.](/changelog/command-line) +
+ -
+