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: refactor workspaces, projects, and targets #207

Open
wants to merge 63 commits into
base: main
Choose a base branch
from

Conversation

stefanicjuraj
Copy link
Contributor

Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
src/content/docs/usage/runners.mdx Outdated Show resolved Hide resolved
src/content/docs/usage/runners.mdx Outdated Show resolved Hide resolved
src/content/docs/usage/runners.mdx Outdated Show resolved Hide resolved
src/content/docs/usage/runners.mdx Outdated Show resolved Hide resolved
src/content/docs/usage/runners.mdx Outdated Show resolved Hide resolved
src/content/docs/usage/runners.mdx Outdated Show resolved Hide resolved
src/content/docs/configuration/targets.mdx Outdated Show resolved Hide resolved
src/content/docs/configuration/workspaces.mdx Outdated Show resolved Hide resolved
src/content/docs/configuration/workspaces.mdx Outdated Show resolved Hide resolved
src/content/docs/usage/workspaces.mdx Show resolved Hide resolved
src/content/docs/usage/runners.mdx Outdated Show resolved Hide resolved
@stefanicjuraj stefanicjuraj requested a review from Tpuljak January 8, 2025 22:48
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
src/content/docs/configuration/providers.mdx Outdated Show resolved Hide resolved
src/content/docs/configuration/target-config.mdx Outdated Show resolved Hide resolved
src/content/docs/configuration/target-config.mdx Outdated Show resolved Hide resolved
src/content/docs/configuration/target-config.mdx Outdated Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

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

Commenting here since I can't comment on unchanged code.

We need to refactor the container registries page. We no longer have CR commands.
Instead, they are managed through env variables.

Screenshot 2025-01-21 at 08 54 11

(Similar setup to Codespaces - https://docs.github.com/en/codespaces/reference/allowing-your-codespace-to-access-a-private-registry)

Mention that the user can set "global" CRs with daytona env set and per-workspace CRs by adding those envs into a workspace (or workspace template)

@@ -193,148 +194,11 @@ Set the Project Builder at Workspace creation time using command-line
flags. Refer to **[Builders](/docs/usage/builders)** for more information.
</Aside>

## Create a Workspace with Multiple Projects
Copy link
Member

Choose a reason for hiding this comment

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

Can't put the comment above since it's unchanged, but please update the creation logs. They're different now since there are no more projects

Also, I would remove the TC selection stuff. It just bloats this section. We can just say (for example) If you don't have a default target set (tip: daytona target set-default), you will be prompted to select a target for that workspace

Copy link
Member

@Tpuljak Tpuljak Jan 22, 2025

Choose a reason for hiding this comment

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

@stefanicjuraj the logs are still wrong. There is no more WORKSPACE tags.

 local   | ✓ Request submitted
 kubectl | Creating workspace kubectl (c3f44c5c14bf)
 kubectl | Pulling image...
 kubectl | Pulling from daytonaio/workspace-project
 kubectl | Digest: sha256:2bbb1ea57364e2bba5d15c02a7d8b0cafd633fd1881ab6ab60ef2ed95aec6edc
 kubectl | Status: Image is up to date for daytonaio/workspace-project:latest
 kubectl | ✓ Image pulled successfully
 kubectl | UIDs and GIDs are the same (1000:1000).
 kubectl | Cloning into '/workdir/kubectl'...
 kubectl | UIDs and GIDs are the same (1000:1000).
 kubectl | ✓ Workspace kubectl created

Note: local is the name of the target and kubectl is the name of the workspace

src/content/docs/usage/workspaces.mdx Outdated Show resolved Hide resolved

1. Run the following command:
1. Run the following command to list all your Workspaces:
Copy link
Member

Choose a reason for hiding this comment

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

The list command view was updated. Update the table below

Copy link
Member

Choose a reason for hiding this comment

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

Screenshot 2025-01-22 at 10 29 58

This is how it should look like

src/content/docs/usage/workspaces.mdx Outdated Show resolved Hide resolved
src/content/docs/usage/workspaces.mdx Show resolved Hide resolved
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>

Daytona provides an option to add a container registry for your Workspace.
Daytona provides options to set global environment variables that apply to all Workspaces or set environment variables for a specific Workspace. To set environment variables for a specific Workspace, set the environment variables within the Workspace directory.
Copy link
Member

Choose a reason for hiding this comment

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

To set environment variables for a specific Workspace, set the environment variables within the Workspace directory.

This doesn't make much sense.

Mention that to set "server-wide" CRs (on every new workspace), users use daytona env and to set on a per-workspace basis they can set the envs on templates or on workspaces with --env when creating

```

:::note
If you have not previously installed a [Runner](/docs/usage/runners), Daytona will prompt you select a Runner to manage the Provider. Upon selecting, Daytona will install the Runner on the target system and connect it to the Daytona Server.
Copy link
Member

Choose a reason for hiding this comment

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

Remove the note

```

:::note
If you have not previously installed a Provider, registered a Runner, or created a Target Configuration, Dayona will prompt you to complete these steps before creating a Target.
Copy link
Member

Choose a reason for hiding this comment

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

In line with the convo we had on Slack, let's assume that the user has Target Configs configured and they just need to choose it to create a target.

We leave creating the TC for the TC page


1. Run the following command:
1. Run the following command to list all your Workspaces:
Copy link
Member

Choose a reason for hiding this comment

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

Screenshot 2025-01-22 at 10 29 58

This is how it should look like

Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants