Contributing content to this site is easy!

Easiest Way

If you're not comfortable with markdown format, just write a well formatted (titles, bold etc.) Word document and email to services.apac@dynatrace.com. We'll do the conversion and upload for you.

Technical: Markdown format

We use Google Codelab syntax for this site.

If you are comfortable with Markdown, read on. The Markdown file you create has a specific syntax. Read on (or search for "Google Codelab syntax").

Once authored, we will then translate that to a tutorial and upload for you (or you can do it yourself).

Create a new file called my-tutorial.md.

Start with the mandatory metadata:

summary: My Tutorial
id: my-tutorial
categories: sometech
tags: sometech
status: Published
authors: Your Name
Feedback Link: https://dt-apac-services.github.io/site/

Now give your tutorial a title using the largest heading (denoted by a single hash)

# My Tutorial Title Here

For example, the title tag of this document is:

# Creating Tutorials

Double hashes (a slightly smaller header) give you the left hand sections on the page. For example, this section of the tutorial was created by using:

## Add Sections

You can then add further content below the header or indeed add a subheading using three hashes. For example:

### An Example Subheading

Some additional text...

Gives this:

An Example Subheading

Some additional text...

Congratulations, you're reading to contribute to our knowledge base! Either do the easy bit or the advanced bit - both will work!

Easy

Email your markdown file or Word doc) to services.apac@dynatrace.com. We will take care of the rest and notify you when it's all done.

Advanced

Preview Your Work (optional)

1. Download the Google Codelab-as-a-thing binary (claat tool) from here
2. Run claat export yourfile.md and the output should say: ok my-tutorial
3. Look in your folder directory and you'll see a new subfolder generated by claat. This is your finished tutorial in HTML format
4. Run claat serve which will open a browser window and your tutorial will be displayed

Doesn't look as expected? Make sure your line endings are set to Unix (LF) not Windows

Contribute

1. Create a branch on https://github.com/dt-apac-services/site. If you don't have access, email services.apac@dynatrace.com with your GitHub username and request access.
2. Drop the folder that claat generated into a subfolder of site/tutorials/yourFolder
3. Modify site/README.md (which serves as the homepage) and add a hyperlink to your tutorial
4. Create a Pull Request and approve it. Once merged into main your link will be live on the site within minutes