Skip to content

Commit

Permalink
new and updated templates
Browse files Browse the repository at this point in the history
  • Loading branch information
napcs committed Oct 27, 2020
1 parent 72ff04c commit 5971beb
Show file tree
Hide file tree
Showing 4 changed files with 483 additions and 9 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# do-article-templates — DigitalOcean Community Article Templates

Please use these templates in addition to our style guide (do.co/style) to help you create articles for the DO community.
Please use these templates in addition to our [style guide](do.co/style) to help you create articles for the DigitalOcean community.

Choose the template that best fits the kind of content you're creating:

* `systems_procedural_tutorial_template.md.txt` - Template for long-form "How To" tutorials about servers, Kubernetes, Terraform, Ansible, and other systems/DevOps content.
* `software_development_tutorial_template.md.txt` - Template for long-form "How To" tutorials on software development (React, Node.js, Python, Go, etc)
* `conceptual_tutorial_template` - Template for conceptual articles that explore a subject at a high level.

These are not substitutes for the [DO Style and Formatting Guide](http://do.co/style). If this is your first article, please read the Guides in their entirety before starting.

Expand Down
142 changes: 142 additions & 0 deletions conceptual_tutorial_template.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
<!--
This is an article template you can use as a quick starting point when writing DigitalOcean conceptual tutorials.

Once you've reviewed the template, delete the comments and begin writing your outline or article. You'll find some examples of our custom Markdown at the very bottom of the template.

As you write, refer to our style and formatting guidelines for more detailed explanations:

- [do.co/style](https://do.co/style)

Use our [Markdown previewer](https://www.digitalocean.com/community/markdown) to review your article's formatting.

-->


# Understanding [Some Concept]

<!-- Use Title Case for all Titles -->

<!-- Learn about the title, introduction, and Goals sections at https://do.co/style#title-introduction-and-goals -->

<!-- Learn about formatting headers at https://do.co/style#headers -->

### Introduction

<!-- Our articles have a specific structure. Learn more at https://do.co/style/structure -->

Introductory paragraph about the topic that explains what this topic is about and why the reader should care; what problem does it solve?

In this guide, you will [explore] [some thing]...

When you're finished, you'll be able to...

## Prerequisites

<!-- Prerequisites let you leverage existing tutorials so you don't have to repeat installation or setup steps in your tutorial. Learn more at https://do.co/style#prerequisites -->


##

<!-- For more information on steps, see https://do.co/style/#steps -->

Introduction to the step. What are we going to do and why are we doing it?

First....

Next...

Finally...


Now transition to the next section by telling the reader what's next.

## Another Section

Another introduction

Your content

Transition to the next section


## Conclusion

In this article you [explored/learned] [something]. Now you can....

<!-- Speak to reader benefits of this technique or procedure and optionally provide places for further exploration. -->


<!------------ Formatting ------------------------->

<!-- Some examples of how to mark up various things

This is _italics_ and this is **bold**.

Only use italics and bold for specific things. Learn more at https://do.co/style#bold-and-italics

This is `inline code`. Use it for referencing package names and commands.

Here's a command someone types in the Terminal:

```command
sudo nano /etc/nginx/sites-available/default
```

Here's a configuration file. The label on the first line lets you clearly state the file that's being shown or modified:

```nginx
[label /etc/nginx/sites-available/default]
server {
listen 80 default_server;
listen [::]:80 default_server ipv6only=on;

root <^>/usr/share/nginx/html<^>;
index index.html index.htm;

server_name localhost;

location / {
try_files $uri $uri/ =404;
}
}
```

Here's output from a command:

```
[secondary_label Output]
Could not connect to Redis at 127.0.0.1:6379: Connection refused
```

Learn about formatting commands and terminal output at https://do.co/style#code

Key presses should be written in ALLCAPS with in-line code formatting: `ENTER`.

Use a plus symbol (+) if keys need to be pressed simultaneously: `CTRL+C`.

This is a <^>variable<^>.

This is an `<^>in-line code variable<^>`

Learn more about how to use variables to highlight important items at https://do.co/style#variables

Use `<^>your_server_ip<^>` when referencing the IP of the server. Use `111.111.111.111` and `222.222.222.222` if you need other IP addresses in examples.

Learn more about host names and domains at https://do.co/style#users-hostnames-and-domains

<$>[note]
**Note:** This is a note.
<$>

<$>[warning]
**Warning:** This is a warning.
<$>

Learn more about notes at https://do.co/style#notes-and-warnings

Screenshots should be in PNG format and hosted on imgur. Embed them in the article using the following format:

![Alt text for screen readers](/path/to/img.png)

Learn more about images at https://do.co/style#images-and-other-assets
-->
Loading

0 comments on commit 5971beb

Please sign in to comment.