licencing

README.md

@@ -1,76 +1,106 @@
-# Content Repository for Technical Writers
+# Daytona Content Programme for Technical Writers
 
-Welcome to the `content` repository! This repo is dedicated to managing external technical writers who can contribute articles and guides. Here, you'll find details on how to participate, contribute, and get paid for your work.
+Welcome to the [Daytona](https://www.daytona.io) `content` repository! This repo is dedicated to managing external technical writers who contribute articles and guides. Here, you'll find details on how to participate, contribute, and get paid for your work.
 
 ## Table of Contents
-- [Content Repository for Technical Writers](#content-repository-for-technical-writers)
+- [Daytona Content Programme for Technical Writers](#daytona-content-programme-for-technical-writers)
   - [Table of Contents](#table-of-contents)
   - [Introduction](#introduction)
   - [Writing Guidelines](#writing-guidelines)
+    - [Content Types](#content-types)
     - [Writing Structure](#writing-structure)
     - [Assets](#assets)
-    - [Fact Check](#fact-check)
+    - [Fact Checking](#fact-checking)
     - [Interlinking](#interlinking)
     - [Glossary/Definitions](#glossarydefinitions)
-    - [Notes](#notes)
+    - [Evergreen Content](#evergreen-content)
+  - [Contribution Process](#contribution-process)
     - [Editing Process](#editing-process)
-    - [Get Published](#get-published)
-    - [Get Paid](#get-paid)
+    - [Publication](#publication)
+    - [Payment](#payment)
+  - [Quality Assurance](#quality-assurance)
+  - [Licensing and Copyright](#licensing-and-copyright)
+  - [Contact and Support](#contact-and-support)
 
 ## Introduction
-The `content` repository is a platform where technical writers can contribute articles to Daytona Dotfiles Insider blog by "solving" posted issues (proposed article ideas) through pull requests. If your PR is merged, you will be compensated.
+The `content` repository is a platform where technical writers can contribute articles to the [Daytona Dotfiles Insider](https://www.daytona.io/dotfiles/) blog by "solving" posted issues (proposed article ideas) through pull requests. Merged PRs are eligible for compensation.
 
 ## Writing Guidelines
 
-Articles and guides should be saved in their respective folders, `articles` or `guides`, following the naming convention `YYYYMMDD_title_of_the_article.md`.
-
-Articles should be at least 1500 words and follow Draft.dev’s excellent [style guide](https://draft.dev/learn/styleguide).
+### Content Types
+- **Articles**: In-depth explorations of topics, at least 800 words.
+- **Guides**: Step-by-step instructions for specific tasks or processes, at least 1500 words.
 
 ### Writing Structure
-- **Headings**: Use H2 subtitles to structure your content, ensuring each article has several to facilitate the TOC.
-- **Formatting**:
-  - Use **bold**, *italic*, and _underline_ for emphasis.
-  - Include `code elements` where necessary.
-  - Add links on important keywords.
-  - Use notes, quotes, TLDR sections (short bullet lists), and key points to enhance readability.
-- **Introduction**: Always start with at least two paragraphs for the introduction before the first H2 section.
+- Use the provided templates in `articles` and `guides` folders.
+- Follow the naming convention: `YYYYMMDD_title_of_the_content.md`.
+- Structure content with H2 subtitles for easy navigation.
+- Include a comprehensive introduction before the first H2 section.
+- Utilize formatting techniques: **bold**, *italic*, `code elements`, and links.
+- Incorporate notes, quotes, TL;DR sections, and key points for enhanced readability.
 
 ### Assets
-- **Storage**: Save all images in the `/assets` folder.
-- **Naming**: Name images the same as the article with an extra suffix, e.g., `YYYYMMDD_title_of_the_article_img1.png`.
-- **Placement**: Do not embed images directly in the article; link to them from the `/assets` folder.
+- Store images in the `/assets` folder within the respective content type folder.
+- Name images consistently: `YYYYMMDD_title_of_the_content_img1.png`.
+- Reference images using relative paths from the `/assets` folder.
 
-### Fact Check
-ALWAYS ensure your information is accurate and up-to-date.
+### Fact Checking
+Ensure all information is accurate and up-to-date. Verify facts and cite sources where necessary.
 
 ### Interlinking
-Link relevant keywords to the following pages for definitions or related content:
+Link relevant keywords to:
 - [Daytona Dotfiles Sitemap](https://www.daytona.io/sitemap-dotfiles.xml)
 - [Daytona Definitions Sitemap](https://www.daytona.io/sitemap-definitions.xml)
 
 ### Glossary/Definitions
-If you encounter a new term that could be added to Daytona Definitions page, mark it in the article and add a comment with a one-line description.
+Mark new terms that could be added to the Daytona Definitions page with a comment containing a concise description.
+
+### Evergreen Content
+Focus on creating long-lasting content. Avoid referencing specific versions of technology that may quickly become outdated.
+
+## Contribution Process
 
-### Notes
-Aim for long-lasting and evergreen content. Avoid mentioning specific versions of technology that may soon become outdated.
+1. Choose an open issue (proposed article idea).
+2. Fork the repository and create a new branch for your content.
+3. Write your article or guide following the provided templates and guidelines.
+4. Submit a pull request for review.
 
 ### Editing Process
-Your article will go through up to two rounds of editing:
-- We suggest reading your article out loud and running it through [Grammarly](https://grammarly.com).
-- Authors will need to respond to edits and update the article accordingly.
-- Articles not meeting our standards will not be published.
+- Articles undergo up to two rounds of editing.
+- Use tools like [Grammarly](https://grammarly.com) for initial proofreading.
+- Respond promptly to editorial feedback and make necessary revisions.
+
+### Publication
+Upon approval, you'll be informed of the publication date.
+
+### Payment
+- Compensation is provided for accepted and published content.
+- Payment can be made directly or through bounties (if assigned to the issue).
+- Submit an invoice including:
+  - Date, Title of Article/Guide, Amount
+  - Payment details (Bank Name, Account Number/IBAN, Routing Number/SWIFT Code/ABA)
+
+## Quality Assurance
+We use `markdownlint` to ensure consistency in Markdown formatting. Run `npm run lint` before submitting your PR to check for any style issues.
+
+## Licensing and Copyright
+
+By contributing to this repository, you agree that all content you submit is subject to the following terms:
+
+1. **Copyright Assignment**: You assign all rights, title, and interest in and to the copyright of your contributed content to Daytona.
+
+2. **Exclusive Rights**: Daytona retains exclusive, worldwide, royalty-free, perpetual, and irrevocable rights to use, reproduce, modify, adapt, publish, distribute, and display the contributed content in any form or medium.
+
+3. **No Reuse Without Permission**: Contributors may not reuse, republish, or redistribute the content they've submitted without explicit written permission from Daytona.
 
-### Get Published
-Once approved, we will inform you of the publication date.
+4. **Attribution**: While Daytona owns the copyright, we will provide attribution to contributors as the original authors of the content, unless requested otherwise.
 
-### Get Paid
-Upon acceptance:
-- You will be paid directly or through bounties in case one was assigned to the issue.
+5. **Warranty**: By submitting content, you warrant that you have the right to assign copyright as described above and that the content does not infringe upon the rights of any third party.
 
-To get paid, send us an invoice including:
-- Date, Title of Article, Amount.
-- Payment details such as: Bank Name, Account Number/IBAN, Routing Number/SWIFT Code/ABA.
+These terms ensure that Daytona can freely use and manage the contributed content while acknowledging the valuable work of our contributors.
 
-For help with invoicing or other payment-related questions, feel free to reach out on [Slack](https://go.daytona.io/slack).
+## Contact and Support
+- For questions or assistance, open an issue or contact the repo maintainers.
+- Join our [Slack community](https://go.daytona.io/slack) for discussions and support.
 
-Happy writing! If you have any questions, feel free to open an issue or contact the repo maintainers.
+Happy writing, and thank you for contributing to the Daytona Dotfiles Insider blog!