Skip to content

Commit

Permalink
updated templates
Browse files Browse the repository at this point in the history
  • Loading branch information
nkkko committed Aug 19, 2024
1 parent b72edcd commit 10667a8
Show file tree
Hide file tree
Showing 6 changed files with 409 additions and 9 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules/
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Daytona Content Programme for Technical Writers

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.
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 compensated for your work.

## Table of Contents
- [Daytona Content Programme for Technical Writers](#daytona-content-programme-for-technical-writers)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ author: "Author Name"

## Introduction

*[Write at least two paragraphs introducing the topic. Provide some background and explain why this topic is important.]*
*[Write at least two paragraphs introducing the topic. Provide some background and explain why this topic is important. Use inline links for definitions where appropriate, e.g., [term](/definitions/term.md).]*

### TL;DR

- **Bullet Point Summary**: *[Summarize the key points in a few bullet points for quick reference.]*

## Subtitle 1

*[Write the content of the first section here. Use clear and concise language, and ensure that each paragraph flows logically to the next.]*
*[Write the content of the first section here. Use clear and concise language, and ensure that each paragraph flows logically to the next. Continue to use inline links for definitions and sitemap articles where appropriate.]*

**Key Point:** *[Highlight key information here.]*

Expand Down Expand Up @@ -61,5 +61,7 @@ print("Hello, World!")

*[Add links to related articles or further reading that might interest the reader.]*

<!-- Glossary/Definitions -->
<!-- Add comments with definitions for new keywords encountered. -->
<!-- Note on Definitions -->
<!-- Throughout this article, link relevant terms to their definitions using inline Markdown links. -->
<!-- Format: [term](/definitions/term.md) -->
<!-- If a definition doesn't exist, create it in the definitions directory and link to it. -->
21 changes: 21 additions & 0 deletions definitions/YYYYMMDD_definition_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "[Term to be Defined]"
description: "A brief description of the term"
date: YYYY-MM-DD
author: "Author Name"
---

# [Term to be Defined]

## Definition

[Provide a clear and concise definition of the term]

## Context and Usage

[Explain the context in which this term is typically used and how it's applied in practice]

## Examples

1. [Example 1]
2. [Example 2]
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ author: "Author Name"

## Introduction

*[Write at least two paragraphs introducing the topic and what the guide will help the reader accomplish. Include any prerequisites.]*
*[Write at least two paragraphs introducing the topic and what the guide will help the reader accomplish. Include any prerequisites. Use inline links for definitions where appropriate, e.g., [term](/definitions/term.md).]*

### TL;DR

Expand All @@ -19,7 +19,7 @@ author: "Author Name"

### Subheading (if needed)

*[Detail any preparatory steps the reader needs to take before starting the main guide.]*
*[Detail any preparatory steps the reader needs to take before starting the main guide. Continue to use inline links for definitions and sitemap articles where appropriate.]*

**Example:**

Expand Down Expand Up @@ -67,5 +67,7 @@ sudo apt-get update

*[Add links to related guides or further reading that might interest the reader.]*

<!-- Glossary/Definitions -->
<!-- Add comments with definitions for new keywords encountered. -->
<!-- Note on Definitions -->
<!-- Throughout this guide, link relevant terms to their definitions using inline Markdown links. -->
<!-- Format: [term](/definitions/term.md) -->
<!-- If a definition doesn't exist, create it in the definitions directory and link to it. -->
Loading

0 comments on commit 10667a8

Please sign in to comment.