You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/DOCUMENTATION_TEMPLATE.md
+3-42Lines changed: 3 additions & 42 deletions
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ This page describes the submitting process and serves as a template for a proper
5
5
The contribution workflow is the same as submitting code.
6
6
7
7
1. Create a branch from the `develop` branch in the [MFTF repository][].
8
-
1. Make edits/additions/deletions as needed.
8
+
1. Make edits/additions/deletions as needed. Read the [Basic Template][] for tips on how to write with Markdown.
9
9
1. Submit your PR to the `develop` branch.
10
10
11
11
Once submitted, a member of the documentation team will review and merge it.
@@ -14,47 +14,7 @@ We will inform you if it needs any additional processing.
14
14
The documentation in this repository is used as the source for the [MFTF documentation][].
15
15
Any changes to the table of contents will need to be made through a separate pull request in the regular [Magento Developer documentation repository][].
16
16
17
-
## Ordered lists
18
-
19
-
1. Number all ordered list items as `1.`
20
-
1. Single space after the number.
21
-
1. Blank line before and after list.
22
-
23
-
## Unordered lists
24
-
25
-
- Use dashes in unordered lists.
26
-
- Add one space after the dash.
27
-
- Add a blank line before and after list.
28
-
29
-
## Code samples
30
-
31
-
For technical words such as a database table name, wrap with single backticks: `tablename`.
32
-
For code block highlighting, wrap code samples in the following format:
33
-
34
-
35
-
```xml
36
-
<xmlSample>
37
-
...
38
-
...
39
-
</xmlSample>
40
-
```
41
-
42
-
Replace the `xml` with the corresponding language (tupe) of the code sample. Use `bash` for shell commands and `terminal` for terminal output.
43
-
44
-
## Markdown tables
45
-
46
-
| Header | Header |
47
-
| ----------- | ----------- |
48
-
| Column 1 text | Column 2 text|
49
-
| Column 1 text | Column 2 text|
50
-
51
-
Markdown formatting works for simple tables. It does not support multiline content within a cell, or split/merged cells within a row or column.
52
-
53
-
## Other tips
54
-
55
-
- Use spaces instead of tabs.
56
-
- Do not duplicate blank lines.
57
-
- Read more about how to [Contribute to Magento Devdocs][]
17
+
Read more about how to [Contribute to Magento Devdocs][].
58
18
59
19
<!-- For readability, we abstract the link URLS to the bottom of the page. The extra set of square brackets denotes it is a link, rather than plain brackets. >
60
20
@@ -63,3 +23,4 @@ Markdown formatting works for simple tables. It does not support multiline conte
0 commit comments