-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'daytonaio:main' into containerize
- Loading branch information
Showing
116 changed files
with
3,260 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| # Reviewing Daytona Content Programme Contributions | ||
|
|
||
| Thank you for participating in the review process of the Daytona Content Programme! This document outlines the streamlined procedures and best practices for reviewing contributions to our repository. By following these standards, we ensure that all content maintains high quality, consistency, and aligns with our program's objectives. | ||
|
|
||
| ## Table of Contents | ||
| - [Role of a Reviewer](#role-of-a-reviewer) | ||
| - [Reviewing Process](#reviewing-process) | ||
| - [Review Guidelines](#review-guidelines) | ||
| - [Content Quality](#content-quality) | ||
| - [Replicability and Accuracy](#replicability-and-accuracy) | ||
| - [Adherence to Guidelines](#adherence-to-guidelines) | ||
| - [Review Checklist](#review-checklist) | ||
| - [Providing Feedback](#providing-feedback) | ||
| - [Approval and Merging](#approval-and-merging) | ||
| - [Handling Revisions](#handling-revisions) | ||
| - [Conflict Resolution](#conflict-resolution) | ||
| - [Resources](#resources) | ||
|
|
||
| ## Role of a Reviewer | ||
| As a reviewer, your primary responsibilities include: | ||
|
|
||
| - Evaluating the submitted content for quality, accuracy, and adherence to guidelines. | ||
| - Providing constructive feedback to authors to help improve their contributions. | ||
| - Ensuring consistency and alignment with the Daytona Content Programme's standards. | ||
| - Facilitating the smooth publication of high-quality content. | ||
|
|
||
| ## Reviewing Process | ||
|
|
||
| 1. **Assignment**: Reviewers are assigned to pull requests (PRs) based on their expertise and availability. | ||
| 2. **Initial Assessment**: Conduct a preliminary review to check for completeness and basic adherence to submission guidelines. | ||
| 3. **Detailed Review**: Evaluate the content in-depth, focusing on quality, accuracy, and replicability. | ||
| 4. **Feedback Provision**: Leave detailed comments and suggestions for improvement. | ||
| 5. **Final Assessment**: After revisions, perform a final check to ensure all feedback has been addressed. | ||
| 6. **Approval**: Approve the PR for merging if it meets all standards. | ||
|
|
||
| ## Review Guidelines | ||
|
|
||
| ### Content Quality | ||
|
|
||
| - **Relevance**: Ensure the content is relevant to the Daytona ecosystem and aligns with the programme's objectives. | ||
| - **Originality**: Verify that the content is original and free from plagiarism. | ||
| - **Depth**: Check that the content provides comprehensive coverage of the topic, offering valuable insights and information. | ||
|
|
||
| ### Replicability and Accuracy | ||
|
|
||
| - **Replicability**: For how-to articles and guides, ensure that all steps are clear, complete, and can be followed by the reader without confusion. Test the instructions yourself if possible. | ||
| - **Accuracy**: Verify that all factual information is correct. Cross-check data points, statistics, and references to ensure their validity. | ||
| - **References**: Ensure that all claims are supported by reliable sources and that references are properly cited. | ||
|
|
||
| ### Adherence to Guidelines | ||
|
|
||
| - **Contribution Guidelines**: Ensure that the content adheres to the [Contributing.md](https://github.com/daytonaio/content/blob/main/CONTRIBUTING.md) guidelines. Avoid repeating instructions here; instead, reference the relevant sections. | ||
| - **Naming Conventions and Formatting**: Confirm that naming conventions and formatting follow the established standards as outlined in the [Contributing.md](./CONTRIBUTING.md). | ||
|
|
||
| ## Review Checklist | ||
|
|
||
| Before finalizing your review, ensure the following checklist items are addressed: | ||
|
|
||
| - [ ] **Template Usage**: Correct template used (`articles`, `guides`, etc.). | ||
| - [ ] **File Naming**: Proper `YYYYMMDD_title_of_the_content.md` format. | ||
| - [ ] **Content Quality**: Original, relevant, and in-depth content. | ||
| - [ ] **Replicability**: Steps are clear and can be followed by the reader. | ||
| - [ ] **Accuracy**: All facts verified and sources cited. | ||
| - [ ] **Adherence to Guidelines**: Compliance with [Contributing.md](https://github.com/daytonaio/content/blob/main/CONTRIBUTING.md). | ||
| - [ ] **Review Checklist**: All items in this checklist have been addressed. | ||
|
|
||
| ## Providing Feedback | ||
|
|
||
| When providing feedback to authors: | ||
|
|
||
| - **Be Constructive**: Offer clear, actionable suggestions for improvement. | ||
| - **Be Specific**: Point out exact sections or lines that need attention. | ||
| - **Be Respectful**: Maintain a professional and respectful tone, even when pointing out issues. | ||
| - **Encourage**: Highlight what the author did well to motivate and guide them. | ||
|
|
||
| **Example Feedback:** | ||
|
|
||
| > *Great introduction! It sets the stage effectively for AI engineers. However, in the "Step 2: Set Up Your Dev Container" section, the `devcontainer.json` configuration could include additional comments explaining each field for better understanding.* | ||
| ## Approval and Merging | ||
|
|
||
| Once a PR meets all the review criteria: | ||
|
|
||
| 1. **Final Verification**: Ensure all checklist items are satisfied and feedback has been addressed. | ||
| 2. **Approval**: Approve the PR using GitHub’s review tools. | ||
| 3. **Merging**: Merge the PR into the main branch, following repository merge protocols. | ||
| 4. **Publication Notification**: Inform the author of the publication date and any next steps. | ||
|
|
||
| ## Handling Revisions | ||
|
|
||
| If a PR requires revisions: | ||
|
|
||
| 1. **Request Changes**: Use GitHub’s review tools to request specific changes. | ||
| 2. **Detail Required Revisions**: Clearly outline what needs to be addressed. | ||
| 3. **Monitor Progress**: Keep track of the revisions and provide additional feedback if necessary. | ||
| 4. **Re-Review**: Once revisions are made, perform a re-review to ensure all issues are resolved. | ||
|
|
||
| ## Conflict Resolution | ||
|
|
||
| In cases of disagreements or conflicts during the review process: | ||
|
|
||
| 1. **Open Communication**: Encourage open and respectful dialogue between the reviewer and the author. | ||
| 2. **Seek Consensus**: Aim to reach a mutual agreement on necessary changes. | ||
| 3. **Involve Maintainers**: If consensus cannot be reached, involve repository maintainers to mediate and make final decisions. | ||
| 4. **Document Decisions**: Keep a record of discussions and decisions for future reference. | ||
|
|
||
| ## Resources | ||
|
|
||
| - [Contributing.md](https://github.com/daytonaio/content/blob/main/CONTRIBUTING.md): Guidelines for contributors. | ||
| - [Markdown Guide](https://www.markdownguide.org/): Comprehensive guide to Markdown syntax. | ||
| - [Grammarly](https://grammarly.com): Tool for proofreading and grammar checking. | ||
| - [Hemingway App](https://hemingwayapp.com/): Tool for enhancing readability. | ||
| - [LanguageTool](https://languagetool.org/): Tool for grammar and style checking. | ||
|
|
||
| --- | ||
|
|
||
| By adhering to this `REVIEWING.md` process, we ensure that all contributions to the Daytona Content Programme are of the highest quality and provide valuable insights to our community. Thank you for your dedication and commitment to maintaining excellence! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| title: "Daytona Community Hours #7" | ||
| description: " A detailed summary of the new releases, patches, and updates that were mentioned during the Daytona Community Hours #7 YouTube video." | ||
| date: 2024-08-09 | ||
| author: "Team Daytona" | ||
| tags: ["News", "Update", "Project Configs"] | ||
| --- | ||
|
|
||
| As always, in our recent community hours, we reviewed the latest developments and improvements at Daytona. We're excited to walk you through our latest release and give you a sneak peek at what's coming next. Let's dive right in! | ||
|
|
||
| ## TL;DR | ||
|
|
||
| - Project Configs: Let users create multiple projects seamlessly. | ||
| - API Route: Get the URL from any instance of a repository. | ||
| - Workspace Status Checks: Status checks are added to the code and SSH commands. | ||
|
|
||
| ## What's New in This Release | ||
|
|
||
| ### Project Configs feature | ||
|
|
||
| This release introduced a major feature, Project Configs feature that allows you to streamline the project creation process. This new feature will enable users to save project details like repository information, build settings, and environment variables. Also, lets users pre-configure your projects and quickly create new workspaces. Project Configs are a stepping stone towards prebuilds, a feature that will let you set up ready-to-use development environments even faster. | ||
|
|
||
| #### How It Works | ||
|
|
||
| - Create Configs: Use the `daytona project-config` command to define your project configurations. | ||
| - Reuse Configs: When creating a new workspace, simply specify the desired project config. | ||
| - Customize: If needed, override preconfigured settings using the `--blank` flag. | ||
|
|
||
| ### Recent Fixes | ||
|
|
||
| - Note on loginctl Linux server daemon: Added a note to users on Linux to run `loginctl enable-linger $USER` to enable the server daemon to continue running after logging out of the machine. This is specifically useful for servers running on remote machines. | ||
| - Fatal error handling on `ctrl-c`: Now, if you `control-c` out of Daytona, it won't throw a fatal error. It will catch the signal and exit. | ||
| - Inform users about prerequisites when opening a project with VS Code: When setting up VS Code as a default IDE, Daytona now informs the user if VS Code is not installed locally. | ||
| - A root user check on serve: Added a root user check when starting the server and a recommendation on running as a non-root user. | ||
|
|
||
| ## Coming Soon: Builds Runner | ||
|
|
||
| We're thrilled to announce Builds Runner as a key feature in our next release. This substantial progress in our build process will introduce a dedicated service that actively handles pending builds. This will also act as an important prerequisite for the upcoming features in Daytona. | ||
|
|
||
| We're excited to see how these updates impact your workflow. Try them out and let us know what you think! Your feedback helps us continue to improve. | ||
|
|
||
| Have questions? Need more details? Don't hesitate to reach out. Join our Slack [community](https://go.daytona.io/slack). | ||
|
|
||
| ## References | ||
|
|
||
| - To learn more about the `Project Configs` refer to our recent release [notes](https://github.com/daytonaio/daytona/releases/tag/v0.24.0) | ||
| - Watch our office hours video on YouTube: [Daytona Office Hours #7](https://www.youtube.com/watch?v=nVQWa4jmwLc) |
Oops, something went wrong.