Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add offerings availability label #181

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/components/Label.astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<aside class="label">
<section class="starlight-aside__content">
<slot />
</section>
</aside>
5 changes: 5 additions & 0 deletions src/content/docs/configuration/git-providers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ sidebar:
label: Configure Providers
---
import Aside from '@components/Aside.astro'
import Label from '@components/Label.astro'

<Label>
Distribution: **Open Source**, **Cloud**, **Self-Managed**
</Label>

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.

Expand Down
6 changes: 6 additions & 0 deletions src/content/docs/configuration/providers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar:
label: Providers
---

import Label from '@components/Label.astro'

<Label>
Distribution: **Open Source**
</Label>

import Aside from '@components/Aside.astro'
import DocumentList from "@components/DocumentList.astro";
import DocumentListItem from "@components/DocumentListItem.astro";
Expand Down
6 changes: 6 additions & 0 deletions src/content/docs/configuration/targets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar:
label: Targets
---

import Label from '@components/Label.astro'

<Label>
Distribution: **Open Source**
</Label>

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 Down
5 changes: 5 additions & 0 deletions src/content/docs/installation/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ import ScriptPowerShell from './method/script-powershell.mdx'
import ScriptUnix from './method/script-unix.mdx'
import UninstallMacOS from './method/uninstall-macos.mdx'
import UninstallUnix from './method/uninstall-unix.mdx'
import Label from '@components/Label.astro'

<Label>
Distribution: **Open Source**
</Label>

You can install Daytona on [Linux](#linux), [macOS](#macos), and [Windows](#windows) systems.
Each operating system supports both x86_64 and ARM64 architectures.
Expand Down
6 changes: 6 additions & 0 deletions src/content/docs/misc/telemetry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar:
label: Telemetry
---

import Label from '@components/Label.astro'

<Label>
Distribution: **Open Source**, **Self-Managed**
</Label>

All telemetry data is **completely anonymous** and **does not** include any personally identifiable information (PII) or user secrets.
Participation is optional and you may opt-out at any time.

Expand Down
5 changes: 5 additions & 0 deletions src/content/docs/tools/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ title: API
description: A reference of supported operations using the Daytona API.
---

import Label from '@components/Label.astro'

<Label>
Distribution: **Open Source**
</Label>

## GET /apikey

Expand Down
5 changes: 5 additions & 0 deletions src/content/docs/tools/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ sidebar:
label: Daytona CLI Reference
---
import Aside from "@components/Aside.astro";
import Label from '@components/Label.astro'

<Label>
Distribution: **Open Source**, **Cloud**, **Self-Managed**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a bit problematic since the CLI is much different in Open Source and EE.

</Label>

The `daytona` command-line tool provides access to Daytona's core features.
You can use the `daytona` tool for the following operations:
Expand Down
6 changes: 6 additions & 0 deletions src/content/docs/usage/builders.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar:
label: Builders
---

import Label from '@components/Label.astro'

<Label>
Distribution: **Open Source**
</Label>

import Aside from '@components/Aside.astro'
import Keyboard from '@components/Keyboard.astro'

Expand Down
5 changes: 5 additions & 0 deletions src/content/docs/usage/ide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ sidebar:
---

import Aside from '@components/Aside.astro'
import Label from '@components/Label.astro'

<Label>
Distribution: **Open Source**, **Cloud**, **Self-Managed**
</Label>

Daytona allows you to connect to your [Workspace](/docs/usage/workspaces#open-an-existing-workspace) using your default IDE.

Expand Down
6 changes: 6 additions & 0 deletions src/content/docs/usage/prebuilds.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar:
label: Prebuilds
---

import Label from '@components/Label.astro'

<Label>
Distribution: **Open Source**
</Label>

Prebuilds are designed to accelerate development by pre-building your Workspace. When you start a Workspace, the prebuilt environment is used, ensuring that the Workspace is initiated almost instantly.

Prebuilds achieve this by setting up a [project configuration](/docs/usage/projects#project-configuration) that monitors changes in the connected Git Provider's repository.
Expand Down
5 changes: 5 additions & 0 deletions src/content/docs/usage/projects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ sidebar:
---

import Aside from '@components/Aside.astro'
import Label from '@components/Label.astro'

<Label>
Distribution: **Open Source**
</Label>

Projects represent a comprehensive set of settings and resources that define how your code is managed, built, and deployed within a Workspace. Each Project is associated with a specific repository and contains the necessary configurations to ensure a consistent development environment.

Expand Down
6 changes: 6 additions & 0 deletions src/content/docs/usage/server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar:
label: Server
---

import Label from '@components/Label.astro'

<Label>
Distribution: **Open Source**
</Label>

The Daytona Server is a daemon that runs on your machine and handles [Workspaces](/docs/usage/workspaces) related actions.
It provides capabilities for [starting](#start-the-server), [configuring](#configure-the-server), and [stopping](#stop-the-server) server operations.
The primary method of interacting with the server is through the Daytona CLI. Users can also interact with the Daytona Server using its HTTP interface.
Expand Down
5 changes: 5 additions & 0 deletions src/content/docs/usage/workspaces.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ sidebar:
---

import Aside from '@components/Aside.astro'
import Label from '@components/Label.astro'

<Label>
Distribution: **Open Source**, **Cloud**, **Self-Managed**
</Label>

Workspaces serve as isolated environments containing your project’s codebase, dependencies, packages, and configuration, providing a consistent and reproducible setup for development, testing, and deployment.

Expand Down
14 changes: 14 additions & 0 deletions src/styles/components/markdown.scss
Original file line number Diff line number Diff line change
Expand Up @@ -618,6 +618,20 @@
margin-top: 20px;
}
}

.label {
margin-top: 0px;
margin-bottom: 40px;
padding-left: 8px;
border-inline-start: 1px solid;
background-color: var(--bg-color);
border-color: var(--hover-color);
}

.label p {
font-size: 0.9rem;
}

}

section {
Expand Down
2 changes: 1 addition & 1 deletion src/styles/init.scss
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ main {
display: flex;
flex-direction: column;
background: var(--bg-color);
gap: 56px
gap: 16px;
}

section {
Expand Down
5 changes: 5 additions & 0 deletions tools/update-cli-reference.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ sidebar:
label: Daytona CLI Reference
---
import Aside from "@components/Aside.astro";
import Label from "@components/Label.astro";

<Label>
Distribution: **Open Source**, **Cloud**, **Self-Managed**
</Label>

The \`daytona\` command-line tool provides access to Daytona's core features.
You can use the \`daytona\` tool for the following operations:
Expand Down
7 changes: 6 additions & 1 deletion tools/update-server-reference.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ title: API
description: A reference of supported operations using the Daytona API.
---

import Label from '@components/Label.astro'

<Label>
Distribution: **Open Source**
</Label>
`;

// content to appear below the commands outline
Expand Down Expand Up @@ -44,7 +49,7 @@ function swaggerToMarkdown(swaggerJSON) {
output += `## ${method.toUpperCase()} ${escape(path)}\n`;
output += `${description}\n`;
output += "\n";

if (Object.keys(parameters).length > 0) {
output += "### Parameters\n"

Expand Down