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 executing the following command:

daytona create https://github.com/daytonaio/docs.git

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.
• Explanation
  Background and conceptual information about Daytona and DEMs.
• Installation
  Information around installing Daytona under different environments.
• Reference
  Technical and architectural information about Daytona.
• 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.