Presidium Open Source

Best Practices


Use Article Templates

Presidium includes article templates for each of the pre-defined sections. Templates are text documents that contain instructions and Markdown which can be modified to meet your needs.

For example, here is the template for the Best Practices section:

```# Template Instructions
# ---------------------   
# 1) Replace any content placeholders with the appropriate content. Search for "REPLACE WITH".
# 2) Delete this line and all lines above so that the front matter below is at the top of the file.
---
title: REPLACE WITH Best Practice Title
author: REPLACE WITH repository username
---

REPLACE WITH a summary paragraph of the recommended practice.

```python
    REPLACE WITH A code snippet, if required, that illustrates the recommended practice. Change the name of the language if needed. DELETE the entire section if not required.
```

# Discussion

REPLACE WITH a discussion of the recommended practice. Add subheadings, code snippets and tables as required.

# See Also

* [REPLACE WITH a link description](http://www.example.com)

Discussion

Templates encourage consistency and provide a simple checklist that an author can use for inspiration.