Skip to content

Commit

Permalink
docs: fix broken links & hyperlinks (#140)
Browse files Browse the repository at this point in the history 
Signed-off-by: stefanicjuraj <[email protected]>
  • Loading branch information
@stefanicjuraj
stefanicjuraj authored Sep 9, 2024
1 parent 8a51ff7 commit f96517b
Show file tree
Hide file tree
Showing 11 changed files with 51 additions and 50 deletions.
1 change: 1 addition & 0 deletions astro.config.mjs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ const myThemeLight = ExpressiveCodeTheme.fromJSONString(jsonLightString)
// https://astro.build/config
export default defineConfig({
site: PUBLIC_WEB_URL,
base: '/docs',
integrations: [
react(),
starlight({
Expand Down
46 changes: 23 additions & 23 deletions src/content/docs/about/getting-started.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ Daytona supports multiple operating systems and architectures. Ensure your syste

| **Operating System** | **Architecture** |
|-----------------------------------------------| --------------------------------------------------|
| <u>[**Linux**](installation/installation#linux)</u> | `x86_64` or `ARM64` |
| <u>[**macOS**](/installation/installation#macos)</u> | `x86_64 (Intel-based)` or `ARM64 (Apple Silicon)` |
| <u>[**Windows**](/installation/installation#windows)</u> | `x86_64` or `ARM64` |
| [Linux](/docs/installation/installation#linux) | `x86_64` or `ARM64` |
| [macOS](/docs/installation/installation#macos) | `x86_64 (Intel-based)` or `ARM64 (Apple Silicon)` |
| [Windows](/docs/installation/installation#windows) | `x86_64` or `ARM64` |

### Dependencies

Expand All @@ -60,22 +60,22 @@ Daytona requires certain tools to be installed on your system to optimize the se

## Installing Daytona

Follow the instructions provided in the [installation](/installation/installation) guide to install Daytona on your operating system. The guide includes detailed steps for installing Daytona on Linux, macOS, and Windows operating systems.
Follow the instructions provided in the [installation](/docs/installation/installation) guide to install Daytona on your operating system. The guide includes detailed steps for installing Daytona on Linux, macOS, and Windows operating systems.

The installation process may vary depending on your operating system and specific environment. Refer to the guide for comprehensive instructions tailored to your setup.

<DocumentList>
<DocumentListItem
title="Linux Installation"
href="/installation/installation#linux"
href="/docs/installation/installation#linux"
/>
<DocumentListItem
title="macOS Installation"
href="/installation/installation#macos"
href="/docs/installation/installation#macos"
/>
<DocumentListItem
title="Windows Installation"
href="/installation/installation#windows"
href="/docs/installation/installation#windows"
/>
</DocumentList>

Expand All @@ -87,24 +87,24 @@ The Daytona Command-Line Interface (CLI) is the primary method of interacting wi

To access the Daytona CLI, open your terminal and use the `daytona` command followed by the desired subcommand. The CLI offers a wide range of commands, each serving a specific purpose, such as creating Workspaces, managing Providers, setting Targets, and configuring system settings.

For a complete list of available commands and their descriptions, refer to the [CLI Reference](/reference/cli). This reference guide provides detailed information on each command, including usage examples and command options, helping you leverage the full potential of the Daytona CLI.
For a complete list of available commands and their descriptions, refer to the [CLI Reference](/docs/reference/cli). This reference guide provides detailed information on each command, including usage examples and command options, helping you leverage the full potential of the Daytona CLI.

Additionally, you can use the `daytona --help` command to list all commands, offering a convenient way to explore available options.

<DocumentList>
<DocumentListItem
title="CLI Reference"
subtitle="Learn how to use the Daytona Command-Line Interface (CLI) to manage your development environments."
href="/reference/cli"
href="/docs/reference/cli"
expanded
/>
</DocumentList>

## Adding a Git Provider

You can integrate Daytona with a [Git Provider](/configuration/git-providers) to manage version control operations and interact with your Git repositories.
You can integrate Daytona with a [Git Provider](/docs/configuration/git-providers) to manage version control operations and interact with your Git repositories.

Daytona supports a variety of Git Providers, including [GitHub](/configuration/git-providers#github), [GitLab](/configuration/git-providers#gitlab), [Bitbucket](/configuration/git-providers#bitbucket), [GitHub Enterprise Server](/configuration/git-providers#github-enterprise-server), [GitLab Self-Managed](/configuration/git-providers#gitlab-self-managed), [Bitbucket Server](/configuration/git-providers#bitbucket-server), [Codeberg](/configuration/git-providers#codeberg), [Gitea](/configuration/git-providers#gitea), [Gitness](/configuration/git-providers#gitness), [Azure DevOps](/configuration/git-providers#azure-devops), and [AWS CodeCommit](/configuration/git-providers#aws-codecommit).
Daytona supports a variety of Git Providers, including [GitHub](/docs/configuration/git-providers#github), [GitLab](/docs/configuration/git-providers#gitlab), [Bitbucket](/docs/configuration/git-providers#bitbucket), [GitHub Enterprise Server](/docs/configuration/git-providers#github-enterprise-server), [GitLab Self-Managed](/docs/configuration/git-providers#gitlab-self-managed), [Bitbucket Server](/docs/configuration/git-providers#bitbucket-server), [Codeberg](/docs/configuration/git-providers#codeberg), [Gitea](/docs/configuration/git-providers#gitea), [Gitness](/docs/configuration/git-providers#gitness), [Azure DevOps](/docs/configuration/git-providers#azure-devops), and [AWS CodeCommit](/docs/configuration/git-providers#aws-codecommit).

This integration supports and enables interacting with your codebase, cloning repositories, and pushing changes directly from Daytona.

Expand All @@ -122,14 +122,14 @@ Use the `daytona git-providers --help` command to view available options for man
<DocumentListItem
title="Add a Git Provider"
subtitle="Learn how to add a Git Provider to Daytona and start managing your repositories effectively."
href="/configuration/git-providers#add-a-git-provider"
href="/docs/configurationg/git-providers#add-a-git-provider"
expanded
/>
</DocumentList>

## Installing a Provider

[Providers](/configuration/providers) are plugins through which Daytona integrates with various technologies to create and manage development environments. Providers abstract complexities of underlying technologies and serve as the foundational engines that Daytona leverages to deploy and run your environments, whether through containerization, orchestration, or cloud-based virtual machines.
[Providers](/docs/configuration/providers) are plugins through which Daytona integrates with various technologies to create and manage development environments. Providers abstract complexities of underlying technologies and serve as the foundational engines that Daytona leverages to deploy and run your environments, whether through containerization, orchestration, or cloud-based virtual machines.

By default, a Docker Provider is configured with `localhost` as the Target.

Expand Down Expand Up @@ -159,41 +159,41 @@ If this configuration meets your requirements, you can proceed with [setting a T

You can install additional Providers to extend Daytona's capabilities and support a wide range of container management platforms and cloud hosting services.

Follow the instructions provided in the [Providers installation](/configuration/providers) guide to install and manage a Provider. The guide includes detailed steps for installing Providers for various container management platforms and cloud hosting services.
Follow the instructions provided in the [Providers installation](/docs/configuration/providers) guide to install and manage a Provider. The guide includes detailed steps for installing Providers for various container management platforms and cloud hosting services.

<DocumentList>
<DocumentListItem
title="Install a Provider"
subtitle="Learn how to install a Provider and interface with the Daytona Server."
href="/configuration/providers"
href="/docs/configuration/providers"
expanded
/>
</DocumentList>

## Setting a Target

A [Target](/configuration/targets) refers to the specific destination or environment where your development setups, facilitated by various Providers, are deployed and managed. Providers define the method and technology used to create your environments, while Targets specify the precise location or platform where these environments will reside.
A [Target](/docs/configuration/targets) refers to the specific destination or environment where your development setups, facilitated by various Providers, are deployed and managed. Providers define the method and technology used to create your environments, while Targets specify the precise location or platform where these environments will reside.

A Target can be a local machine, a remote server, or a cloud instance, and it can vary based on the chosen Provider. Targets offer the flexibility to deploy and manage environments across different platforms and accounts, all within the unified interface provided by Daytona.

Once you set your Target, it becomes available for selection whenever you create a new development environment in Daytona. You can manage multiple Targets or delete those you no longer need.

Follow the instructions provided in the [managing Targets](/configuration/targets) guide to set a Target and configure your development environment deployment settings.
Follow the instructions provided in the [managing Targets](/docs/configuration/targets) guide to set a Target and configure your development environment deployment settings.

Use the `daytona target --help` command to view available configuration options for setting a Target.

<DocumentList>
<DocumentListItem
title="Set a Target"
subtitle="Learn how to set a Target to define how Daytona manages your development environment."
href="/configuration/targets"
href="/docs/configuration/targets"
expanded
/>
</DocumentList>

## Choosing the Default IDE

Daytona allows you to connect to your development environment using a variety of [IDEs](/usage/ide), including popular options like [Visual Studio Code (VSCode)](/usage/ide#vs-code), JetBrains IDEs, and [Terminal SSH](/usage/ide#terminal-ssh).
Daytona allows you to connect to your development environment using a variety of [IDEs](/docs/usage/ide), including popular options like [Visual Studio Code (VSCode)](/docs/usage/ide#vs-code), JetBrains IDEs, and [Terminal SSH](/docs/usage/ide#terminal-ssh).

By setting the default IDE, you can automatically open your development environment in your preferred environment, optimizing your workflow and reducing setup time.

Expand All @@ -217,24 +217,24 @@ Use the `daytona ide` command to view available configuration options for settin
<DocumentListItem
title="Set Default IDE"
subtitle="Learn how to set your default IDE to automatically open your development environment."
href="/usage/ide#set-the-default-ide"
href="/docs/usage/ide#set-the-default-ide"
expanded
/>
</DocumentList>

## Creating your Workspace

Once you have completed the initial setup and configuration steps, you can [create your Workspace](/usage/workspaces#create-a-workspace) using Daytona. A Workspace represents an isolated development environment where you can manage your code, build projects, and collaborate with team members.
Once you have completed the initial setup and configuration steps, you can [create your Workspace](/docs/usage/workspaces#create-a-workspace) using Daytona. A Workspace represents an isolated development environment where you can manage your code, build projects, and collaborate with team members.

Creating a Workspace involves defining the necessary configurations, such as selecting the appropriate [Git Provider](/configuration/git-providers) or entering the Git repository URL. Daytona simplifies this process by providing a user-friendly interface to set up and manage your Workspaces.
Creating a Workspace involves defining the necessary configurations, such as selecting the appropriate [Git Provider](/docs/configuration/git-providers) or entering the Git repository URL. Daytona simplifies this process by providing a user-friendly interface to set up and manage your Workspaces.

To create a Workspace, use the `daytona create` command and follow the prompts to configure your Workspace settings. Once created, you can access your Workspace and interact with your codebase.

<DocumentList>
<DocumentListItem
title="Create a Workspace"
subtitle="Learn how to create your Workspace using Daytona."
href="/usage/workspaces#create-a-workspace"
href="/docs/usage/workspaces#create-a-workspace"
expanded
/>
</DocumentList>
14 changes: 7 additions & 7 deletions src/content/docs/configuration/providers.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import DocumentListItem from "@components/DocumentListItem.astro";

Providers are plugins through which Daytona integrates with various technologies to create and manage development environments. Providers abstract complexities of underlying technologies and serve as the foundational engines that Daytona leverages to deploy and run your environments, whether through containerization, orchestration, or cloud-based virtual machines.

Daytona's architecture decentralizes the role of a Provider into a separate service. The [Daytona Server](/usage/server) communicates with Providers to execute operations relating to Workspace creation and lifecycle management.
Daytona's architecture decentralizes the role of a Provider into a separate service. The [Daytona Server](/docs/usage/server) communicates with Providers to execute operations relating to Workspace creation and lifecycle management.

## Install a Provider

Expand Down Expand Up @@ -41,7 +41,7 @@ v0.0.0
Select a specific version
```

Upon selecting the Provider, Daytona will install and configure the chosen Provider, making it available for managing and deploying Workspaces. You can now create a [Target](/configuration/targets) to use with the created Provider.
Upon selecting the Provider, Daytona will install and configure the chosen Provider, making it available for managing and deploying Workspaces. You can now create a [Target](/docs/configuration/targets) to use with the created Provider.

```text
Provider docker-provider has been successfully installed
Expand Down Expand Up @@ -115,7 +115,7 @@ Provider docker-provider has been successfully uninstalled

## Docker

The Docker Provider allows Daytona to create Workspace projects as Docker containers. Daytona installs a Provider for Docker (`docker-provider`) by default and adds a default [Target](/configuration/targets#docker) using the Docker Provider, allowing the creation of Workspaces on your local machine.
The Docker Provider allows Daytona to create Workspace projects as Docker containers. Daytona installs a Provider for Docker (`docker-provider`) by default and adds a default [Target](/docs/configuration/targets#docker) using the Docker Provider, allowing the creation of Workspaces on your local machine.

1. Run the following command to install a Docker Provider:

Expand Down Expand Up @@ -146,7 +146,7 @@ Provider docker-provider has been successfully installed
<DocumentListItem
title="Set a Docker Target"
subtitle="Learn how to set a local or remote Docker Target to deploy and manage Workspaces."
href="/configuration/targets#docker"
href="/docs/configurationtargets#docker"
expanded
/>
</DocumentList>
Expand Down Expand Up @@ -186,7 +186,7 @@ Provider aws-provider has been successfully installed
<DocumentListItem
title="Set an AWS Target"
subtitle="Learn how to set an AWS Target to deploy and manage Workspaces."
href="/configuration/targets#aws"
href="/docs/configurationtargets#aws"
expanded
/>
</DocumentList>
Expand Down Expand Up @@ -224,7 +224,7 @@ Provider digitalocean-provider has been successfully installed
<DocumentListItem
title="Set a DigitalOcean Target"
subtitle="Learn how to set a DigitalOcean Target to deploy and manage Workspaces."
href="/configuration/targets#digitalocean"
href="/docs/configuration/targets#digitalocean"
expanded
/>
</DocumentList>
Expand Down Expand Up @@ -262,7 +262,7 @@ Provider fly-provider has been successfully installed
<DocumentListItem
title="Set a Fly Target"
subtitle="Learn how to set a Fly Target to deploy and manage Workspaces."
href="/configuration/targets#fly"
href="/docs/configuration/targets#fly"
expanded
/>
</DocumentList>
4 changes: 2 additions & 2 deletions src/content/docs/configuration/targets.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar:
label: Targets
---

A Target refers to the specific destination or environment where your development setups, facilitated by various [Providers](/configuration/providers), are deployed and managed. Providers define the method and technology used to create your environments, while Targets specify the precise location or platform where these environments will reside.
A Target refers to the specific destination or environment where your development setups, facilitated by various [Providers](/docs/configuration/providers), are deployed and managed. Providers define the method and technology used to create your environments, while Targets specify the precise location or platform where these environments will reside.

A Target can be a local machine, a remote server, or a cloud instance, and it can vary based on the chosen Provider. Targets offer the flexibility to deploy and manage environments across different platforms and accounts, all within the unified interface provided by Daytona.

Expand All @@ -17,7 +17,7 @@ Daytona allows you to set a Target to use when managing Workspaces.

**Prerequisite**

- **At least [one Provider installed](/configuration/providers).**
- **At least [one Provider installed](/docs/configuration/providers).**

Providers are essential for managing and deploying your Workspaces, so make sure you have configured at least one.

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/installation/installation.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Each operating system supports both x86_64 and ARM64 architectures.

Daytona leverages [Docker](https://docs.docker.com/engine/install/) to create and manage isolated development environments.

After installing Daytona using the best method for your environment, you can [create a Workspace](/usage/workspaces#create-a-workspace), [add a Git Provider](/configuration/git-providers#add-a-git-provider), [install a Provider](/configuration/providers#install-a-provider), and [use the CLI reference](/reference/cli) to understand Daytona's full array of functionality.
After installing Daytona using the best method for your environment, you can [create a Workspace](/docs/usage/workspaces#create-a-workspace), [add a Git Provider](/docs/configuration/git-providers#add-a-git-provider), [install a Provider](/docs/configuration/providers#install-a-provider), and [use the CLI reference](/docs/reference/cli) to understand Daytona's full array of functionality.

## Linux

Expand Down
Loading

0 comments on commit f96517b

Please sign in to comment.