Markdown

A Sample Ops Guide Markdown Page#

Something About "Why This Guide, In Particular?"#

We wrote this guide because it was an awesome request, and also because it met some business needs.

So you don't like Markdown#

Writing in Markdown is hard. If you're developing on a Mac and would like to see it rendered, try using Macdown. This will allow you to see the live view of the Markdown.

Note that this only applies to standard Markdown, not the customiziations for these guides like tips.

You can test by opening this file with that editor / the Markdown editor of your choice.

Some Markdown Basics#

• Here is a bulleted list
• With another item

And sometimes order matters 1. So this is first 1. And this is second

Some Sample Customized Markdown#

Here's the syntax for customized Markdown that is used in the Guides.

Always Include the License Statement#

However you ultimately build your index.md file, make sure it always has the following at the bottom.

License#

This documentation is provided under the Apache License 2.0. In plain English, that means you can use and modify this documentation and use it both commercially and for private use. However, you must include any original copyright notices and the original LICENSE file.

Whether you are a PagerDuty customer or not, we want you to have the ability to use this documentation internally at your own company. You can view the source code for all of this documentation on our GitHub account. Feel free to fork the repository and use it as a base for your own internal documentation.