Git Product home page Git Product logo

enterprise-docs's Introduction

Daytona logo



License Issues - daytona

Daytona Documentation

Daytona's user and developer documentation.

Report Bug · Join Our Slack · Twitter


Development

The Daytona Documentation website is built using Astro and Stralight. The core of the website is built in React, with documentation and other content built in MDX.

Setting up a Development Environment

The easiest way to start working on the documentation is by using a DEM such as Daytona. You can create a Workspace with the dependencies and configuration needed to preview the docs locally by opening the repo in your installation of Daytona.

Alternatively, if your local machine has Node.js and Yarn set up, you can clone this repository and execute yarn install to install the required dependencies.

Useful Commands

This repository uses Yarn to handle project management. For convenience, a number of scripts are defined in package.json that can be called using Yarn:

Command Action
yarn run dev Starts local dev server at localhost:4321
yarn run build Builds your production site to ./dist/
yarn run preview Previews your build locally before deployment
yarn run astro ... Runs CLI commands like astro add, astro check
yarn run astro -- --help Provides help for using the Astro CLI
yarn run update-cli-reference Update the Daytona CLI reference docs using autogenerated CLI docs`

Navigating the Docs

On the filesystem, you'll find the content in ./src/content/docs in the form of .mdx files. Daytona's documentation is organized into broad topics:

  • Configuration Information around configuring the main components of Daytona.
  • Installation
    Information around installing Daytona under different environments.
  • Tools
    Information about supporting tools.
  • Usage
    Practical information on using Daytona.

Contributing

Daytona is licensed under the Apache License 2.0. If you would like to contribute to the software, you must:

  1. Read the Developer Certificate of Origin Version 1.1 (https://developercertificate.org/)
  2. Sign all commits to the Daytona project.

This ensures that users, distributors, and other contributors can rely on all the software related to Daytona being contributed under the terms of the License. No contributions will be accepted without following this process.

License

This repository contains Daytona's Documentation website, covered under the Apache License 2.0, except where noted (any Daytona logos or trademarks are not covered under the Apache License, and should be explicitly noted by a LICENSE file.)

Daytona is a product produced from this open source software, exclusively by Daytona Platforms, Inc. It is distributed under our commercial terms.

Others are allowed to make their own distribution of the software, but they cannot use any of the Daytona trademarks, cloud services, etc.

We explicitly grant permission for you to make a build that includes our trademarks while developing Daytona itself. You may not publish or share the build, and you may not use that build to run Daytona for any other purpose.

Code of Conduct

This project has adapted the Code of Conduct from the Contributor Covenant. For more information see the Code of Conduct or contact [email protected]. with any additional questions or comments.

Questions

If you need guideance on contributing to Daytona, talk to us on Slack.

enterprise-docs's People

Contributors

mikimih avatar nkkko avatar fabjanvucina avatar zmzlois avatar alzri avatar antevukusic avatar ivan-burazin avatar loisisar avatar vedranjukic avatar stefanicjuraj avatar dependabot[bot] avatar ldavidbryant avatar d4yt0nad0cs avatar amorriscode avatar lucianbuzzo avatar seanavers avatar tpuljak avatar

Stargazers

Luka Brečić avatar Software Nerd avatar  avatar  avatar  avatar Jean-philippe Martel avatar David Rodriguez avatar

Watchers

Goran Draganić avatar  avatar  avatar

enterprise-docs's Issues

Environment variables conventions

Document the use of env variable conventions. These are used to authenticate custom container registries.

For example

GITLAB__CONTAINER_REGISTRY_SERVER=some-project.gitlab.com
GITLAB_CONTAINER_REGISTRY_USER=some-username
GITLAB_CONTAINER_REGISTRY_PASSWORD=some-password

It works similar to Coder's Extenal Auth https://coder.com/docs/admin/external-auth

Workspace classes

Workspace classes should be described in detail (why they exist and what parameters can be set).
The information should explain the maximum limits based on the hardware node availability in the cluster.
GPU availability should be highlighted.

Overprovisioning should be explained - how it works and the pros and cons of setting the overprovisioning factor.

https://www.gitpod.io/docs/configure/workspaces/workspace-classes

Syntax Highlighting for CLI Commands in Documentation

Description

In the documentation, certain CLI commands lack syntax highlighting.

This issue is occurring from the use of triple backticks ( ) instead of specifying the language for syntax highlighting (bash).

Making this minor adjustment will apply the appropriate syntax highlighting to the CLI commands, enhancing readability and clarity for users.

And I Want to Work on this

ScreenShot

Expected:

image

What we got:

image

Add Admin section

Need to add admin section to docs as we now have admin dashboard with:

  • licence
  • workspace-classes
  • users

image

Pin Workspace

Workspaces can be "pinned," which will exclude them from the cleanup procedure if they are unused.

The docs should explain why workspaces are automatically cleaned up, that the cleanup conditions are configurable, and how to use the Pin feature to prevent a workspace from being destroyed if it is unused.

Installer script suggesting command that requires privilege while running as unprivileged user

On a fresh macOS install, the Daytona installer spits out this message while running as an unprivileged

Warning: Destination directory /usr/local/bin does not exist.
         Create the directory:
           mkdir -p /usr/local/bin

Running the installer as an unprivileged user, the suggested mkdir will fail.

Potential solutions:

  1. Have the Daytona install script offer to execute the mkdir command using sudo instead of printing this message and immediately exiting.
  2. Keep the same message, but add a check to the script to see if we're running as a privileged user. If not, prepend sudo in the suggested mkdir command.

Environment Secrets only 50 characters long?

Describe the bug
Environment Secret Value has a maximum of 50 characters only?
Cannot add many of my secret values, they are all longer.
Or is the intention that I have to use something like Doppler?

To Reproduce
Steps to reproduce the behavior:

  1. Go to 'Dashboard: Env Variables"
  2. Enter Secret Value
  3. Only the first 50 characters are stored
  4. That is too short to host my secrets here.

Expected behavior
Secret Value Fields to accept longer values.

Desktop (please complete the following information):

Installer script doesn't check for Docker

The installer script doesn't check to see if the user has Docker installed as a prerequisite to using Daytona. Once Daytona is installed, it does spit this error message out when you try to create a workspace, but it could be made friendlier and caught earlier in the onboarding process:

FATA[0062] failed to create workspace: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?

Update Teams doc

I reviewed the content in the Teams section of the documentation. I think we need to add the following things:

  1. Add steps for inviting members via email

  2. Add info for importing in bulk via CSV file (use the instructions available in the dashboard)

image
  1. In the managing members section, more info should be added regarding the change role/transfer ownership action

  2. We are missing a section which explains the differences between different team roles

Add entry that explains how to fetch all refs in a project

Because Daytona performs a single-branch clone when creating projects, the user is unable to fetch all remote refs by default.

This might be confusing for users so we should add a docs entry that explains how to enable fetching all remote refs.

This guide is very helpful in achieving this.

Screenshots:

Screenshot 2024-05-10 at 12 49 54
Screenshot 2024-05-10 at 12 53 34

Telemetry

Daytona collects anonymous telemetry data to with the goal of improving the Daytona ecosystem.

The docs should explain what data is collected and the flow for opting-out.

Connecting over SSH

The docs should have a dedicated section on how to configure and use the SSH Connection to a Workspace.

This should cover the Public key auth and the Access token auth.
The Access token auth should be explained, like when to use it and how it works.

Update Workspace Create Dashboard Flow

The new flow needs to be documented, as now we have more options on the "Create Workspace" form than before: Git repo URL, IDE choice, and the Workspace Class selector.

The update must include links to describe the Workspace Classes and the section on available IDEs.

Readme

Readme should be edited to be consistent with Daytona and OSS Docs repo

Workspace templates (samples)

Workspace templates (samples) show up as suggested repositories when creating a new workspace.

The docs should explain how these templates can be configured and linked in the Daytona admin dashboard.

Dev Setup

On checkout the process to start the dev view should be identical to OSS docs

Application port preview links

When the application runs in the workspace, Daytona will detect the port and will create a preview link that can be shared with other users.
The link can be set to private or public.

IDE management

Daytona admins can manage which IDEs can be used for opening workspaces.

image

User roles

Daytona supports three user roles: Admin, Team owner, and Team member (developer).

The documentation should describe what features are available to each of the roles.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.