Merge pull request #15 from microsoft/waldo/prettifications
Waldo/prettifications
This commit is contained in:
commit
6abfac51f7
3 changed files with 76 additions and 4 deletions
29
content/Contributing/Templates/Guidelines/index.md
Normal file
29
content/Contributing/Templates/Guidelines/index.md
Normal file
|
|
@ -0,0 +1,29 @@
|
||||||
|
+++
|
||||||
|
title = "Title of the Guideline"
|
||||||
|
weight = 1180
|
||||||
|
+++
|
||||||
|
This is a guideline, some parts are optional (if there's no content, remove the whole paragraph).
|
||||||
|
|
||||||
|
<_Your name here in italics, plus your company name if you wish_\>
|
||||||
|
|
||||||
|
## Abstract
|
||||||
|
|
||||||
|
Short, descriptive and easy to remember description of this pattern.
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
In depth description on what this Pattern is all about
|
||||||
|
- basic components
|
||||||
|
- how the interact
|
||||||
|
- steps to implement
|
||||||
|
- considerations to take
|
||||||
|
|
||||||
|
## Good Example
|
||||||
|
```al
|
||||||
|
PutCodeblocksHere()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Bad Example
|
||||||
|
```al
|
||||||
|
PutCodeblocksHere()
|
||||||
|
```
|
||||||
43
content/Contributing/Templates/Patterns/index.md
Normal file
43
content/Contributing/Templates/Patterns/index.md
Normal file
|
|
@ -0,0 +1,43 @@
|
||||||
|
+++
|
||||||
|
title = "Title of the pattern"
|
||||||
|
weight = 1180
|
||||||
|
+++
|
||||||
|
This is a guideline, some parts are optional (if there's no content, remove the whole paragraph).
|
||||||
|
|
||||||
|
<_Your name here in italics, plus your company name if you wish_\>
|
||||||
|
|
||||||
|
## Abstract
|
||||||
|
|
||||||
|
Short, descriptive and easy to remember description of this pattern.
|
||||||
|
|
||||||
|
## Context:
|
||||||
|
|
||||||
|
Sets the stage where the pattern takes place. 1-2 sentences.
|
||||||
|
|
||||||
|
## Problem:
|
||||||
|
|
||||||
|
What happens before this pattern is used? How can it go wrong? 1-5 lines.
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
In depth description on what this Pattern is all about
|
||||||
|
- basic components
|
||||||
|
- how the interact
|
||||||
|
- steps to implement
|
||||||
|
- considerations to take
|
||||||
|
|
||||||
|
## Usage:
|
||||||
|
|
||||||
|
If applicable: where is it used in an app. You can refer to any app, BaseApp, or a (public) ISV app.
|
||||||
|
|
||||||
|
## Benefits:
|
||||||
|
|
||||||
|
1-2 sentences: what did you just solve
|
||||||
|
|
||||||
|
## When not to use
|
||||||
|
|
||||||
|
Usually, there are occasions where NOT to implement the pattern. List the disadvantages of this pattern here.
|
||||||
|
|
||||||
|
## List of references
|
||||||
|
|
||||||
|
Youtube-link? BaseApp? Tweet? ...
|
||||||
|
|
@ -28,10 +28,10 @@ For some history on this, waldo's posts [Code is Poetry](https://www.waldo.be/20
|
||||||
#### Behind This Project
|
#### Behind This Project
|
||||||
|
|
||||||
This project is a Microsoft Business Central Community initiative with support from the Microsoft Business Central team. The founding community members are
|
This project is a Microsoft Business Central Community initiative with support from the Microsoft Business Central team. The founding community members are
|
||||||
* [Waldo](https://twitter.com/waldo1001)
|
* waldo ([Twitter](https://twitter.com/waldo1001), [Blog](https://www.waldo.be), [GitHub](https://github.com/waldo1001))
|
||||||
* [Arend-Jan Kauffmann](https://twitter.com/ajkauffmann)
|
* Arend-Jan Kauffmann ([Twitter](https://twitter.com/ajkauffmann), [Blog](https://www.kauffmann.nl/), [GitHub](https://github.com/ajkauffmann))
|
||||||
* [Henrik Helgesen](https://twitter.com/TheDoubleH)
|
* Henrik Helgesen ([Twitter](https://twitter.com/TheDoubleH), [GitHub](https://github.com/thedoubleh))
|
||||||
* [Jeremy Vyska](https://twitter.com/JeremyVyska)
|
* Jeremy Vyska ([Twitter](https://twitter.com/JeremyVyska),[Blog](https://jeremy.vyska.info/articles), [GitHub](https://github.com/JeremyVyska))
|
||||||
|
|
||||||
#### Contibuting
|
#### Contibuting
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue