Skip to content

Commit

Permalink
docs: replace "Dev Environment" with "Workspace" (#21)
Browse files Browse the repository at this point in the history
This commit also removes a dead link to Upgrade Notes.

Signed-off-by: Fionn Kelleher <[email protected]>
  • Loading branch information
osslate authored May 24, 2024
1 parent efa2faf commit beb2165
Show file tree
Hide file tree
Showing 7 changed files with 135 additions and 135 deletions.
4 changes: 2 additions & 2 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ export default defineConfig({
"label": "Usage",
"items": [
{
"label": "Dev Environments",
"link": "/usage/dev-environments",
"label": "Workspaces",
"link": "/usage/workspaces",
attrs: {
icon: 'git-commit.svg'
},
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/configuration/git-providers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar:
---

Git Providers — sometimes known as software forges or Source Code Managers (SCMs) — provide a set of tools to host and collaborate on codebases using Git.
Daytona allows you to configure Git Providers and use repositories hosted on them to create Dev Environments.
Daytona allows you to configure Git Providers and use repositories hosted on them to create Workspaces.

## Add a Git Provider
You can add a Git Provider to Daytona.
Expand Down
8 changes: 4 additions & 4 deletions src/content/docs/explanation/what-is-daytona.mdx
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
title: What is Daytona?
description: Understand how Daytona can help you manage your Dev Environments.
description: Understand how Daytona can help you manage your development environments.
sidebar:
label: What is Daytona?
---

Daytona is an open-source Development Environment Manager (DEM) licensed under the Apache License 2.0.
Daytona allows you to manage and deploy reproducible Development Environments (DEs) based on standard OCI containers, with built-in support for the Dev Container standard.
Daytona's architecture provides the future possibility to base Dev Environments using other standards, such as Dockerfiles, Docker Compose configurations, Nix, and Devfile.
Daytona allows you to manage and deploy Workspaces — reproducible development environments based on standard OCI containers, with built-in support for the Dev Container standard.
Daytona's architecture provides the future possibility to base Workspaces on other configuration standards, such as Dockerfiles, Docker Compose, Nix, and Devfile.

By leveraging configuration in a project's remote Git repository, Daytona builds a Dev Environment and provisions a workspace to a platform of your choice.
By leveraging configuration in a project's remote Git repository, Daytona builds a Workspace and provisions a workspace to a platform of your choice.
Once provisioned, you can develop and test the project using an IDE supported by Daytona, such as Visual Studio Code.

Daytona's functionality is exposed through a command-line tool that runs on Linux, macOS, and Windows systems, on both x86-64 and AArch64 architectures.
Expand Down
24 changes: 12 additions & 12 deletions src/content/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Documentation Home
description: Start managing your Dev Environments with Daytona.
description: Start managing your Workspaces with Daytona.
template: doc
head:
- tag: title
Expand Down Expand Up @@ -32,22 +32,27 @@ import DocumentListItem from "@components/DocumentListItem.astro";
href="/installation/installation"
/>
<DocumentListItem
title="Create your first Dev Environment"
subtitle="Once you have Daytona installed, create your first Dev Environment."
href="/usage/dev-environments#create-a-dev-environment"
title="Create your first Workspace"
subtitle="Once you have Daytona installed, create your first Workspace."
href="/usage/workspaces#create-a-workspace"
/>
</DocumentList>

<DocumentList title="Configure">
<DocumentListItem
title="Add a Git Provider"
subtitle="Create Dev Environments from repositories hosted across GitHub, GitLab, Bitbucket, and others."
subtitle="Create Workspaces from repositories hosted across GitHub, GitLab, Bitbucket, and others."
href="/configuration/git-providers#adding-a-git-provider"
/>
<DocumentListItem
title="Add a remote Docker target"
subtitle="Deploy your Workspaces on a remote host using Docker."
href="/configuration/targets#adding-a-docker-target"
/>
<DocumentListItem
title="Set your default IDE"
subtitle="Automatically open your Dev Environments in Visual Studio Code and a selection of JetBrains IDEs."
href="/usage/dev-environments#setting-the-default-ide"
subtitle="Automatically open your Workspaces in Visual Studio Code and a selection of JetBrains IDEs."
href="/usage/workspaces#set-the-default-ide"
/>
</DocumentList>

Expand All @@ -62,9 +67,4 @@ import DocumentListItem from "@components/DocumentListItem.astro";
subtitle="Learn about the Daytona Server and how to manually configure it."
href="/reference/server"
/>
<DocumentListItem
title="Upgrade Notes"
subtitle="If you're upgrading from an older version of Daytona, inform yourself of potential pitfalls."
href="/reference/upgrade-notes"
/>
</DocumentList>
2 changes: 1 addition & 1 deletion src/content/docs/reference/server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar:
label: Server
---

The Daytona Server is a daemon that runs on your machine and handles actions relating to Development Environments.
The Daytona Server is a daemon that runs on your machine and handles actions relating to Workspaces.
The primary method of interacting with the server is through the Daytona CLI, although it's possible to interact manually using a HTTP interface.


Expand Down
115 changes: 0 additions & 115 deletions src/content/docs/usage/dev-environments.mdx

This file was deleted.

115 changes: 115 additions & 0 deletions src/content/docs/usage/workspaces.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
---
title: Workspaces
description: Learn how to create and manage Workspaces using Daytona.
sidebar:
label: Workspaces
---

Workspaces contain your project's codebase, dependencies and packages, and configuration.
Daytona allows you to create Workspaces on various Git Providers

## Create a Workspace
You can create a Workspace.

__Prerequisites__
* A working installation of Daytona.
* At least 1 Target configured.

### From a Configured Git Provider
__Procedure__
1. Execute the following command to start the guided Workspace creation process:
```shell
daytona create
```
2. Select the Git Provider and repository you want your Workspace to be configured with.
3. Wait for Daytona to create the Workspace.

:::tip
To automatically open a new Workspace in Visual Studio Code after creation, use the `--code` flag.

__Example:__
```shell
daytona create --code
```
:::

### From an Arbitrary Git URL
__Procedure__
1. Execute the following command to create a Workspace from a remote Git repository:
```shell
daytona create <REPO_URL>
```

__Example__
```shell
daytona create https://github.com/daytonaio/daytona.git
```
2. Wait for Daytona to create the Workspace.

## List Workspaces
You can list all previously created Workspaces.

1. Execute the following command to see a list of Workspaces:
```shell
daytona list
```

## Open An Existing Workspace
You can open an existing Workspace in your IDE.

__Prerequisites__
* A working installation of Daytona.
* At least 1 existing Workspace.

__Procedure__
1. Execute the following command to list existing Workspaces:
```shell
daytona code
```
2. Select the Workspace you want to open.

:::note
You can configure your preferred IDE.
Refer to __[Set the Default IDE](#set-the-default-ide)__ for more information.
:::

## Delete a Workspace
You can delete an existing Workspace.

__Prerequisites__
* A working installation of Daytona.
* At least 1 existing Workspace.

__Procedure__
1. Run the following command:
```shell
$ daytona delete
```
2. Select the desired Workspace for deletion in the list and hit `Enter`.
3. Confirm the action.

## Set the Default IDE
Daytona allows you to connect to your Workspace using your preferred IDE.
Out of the box, Daytona can be configured to open your Workspace in the following IDEs:

* Visual Studio Code (VSCode)
* Desktop (Linux, macOS, Windows)
* Browser
* JetBrains IDEs
* CLion
* GoLand
* IntelliJ IDEA Ultimate
* PhpStorm
* Rider
* RubyMine
* WebStorm
* Terminal SSH

1. Execute the following command to enter the IDE selection terminal UI:
```shell
daytona ide
```
2. Select your preferred IDE from the list presented.

Your preferred IDE will be opened automatically and connected to your Workspace when using the `daytona open` command.

0 comments on commit beb2165

Please sign in to comment.