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
+15-14Lines changed: 15 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,35 +4,36 @@ MFTF documentation is kept within the /docs/ folder in this repository.
4
4
We welcome contributions to the documentation.
5
5
This page describes the process for submitting documentation and serves as a template for a properly written content.
6
6
7
-
The contribution workflow for docs is the same as submitting code.
7
+
The contribution workflow for the Magento functional testing framework (MFTF) documentation is the same as submitting code.
8
8
To contribute to MFTF docs:
9
9
10
-
1. Make a branch from the [MFTF repo][].
10
+
1. Make a branch from the `develop` branch in the [MFTF repo][].
11
11
1. Make edits/additions/deletions as needed.
12
12
1. Submit your PR to the `develop` branch.
13
13
14
-
Once submitted, it will be reviewed by a member of the documentation team.
14
+
Once submitted, a member of the documentation team will review and merge it.
15
15
If approved it will be tested and merged.
16
16
If it needs any work, we will inform you.
17
17
18
18
Any changes to the Table of Contents will need to be made in the regular [devdocs repo][].
19
19
20
-
## H2 heading - blank line before and after, capitalize first word only
20
+
## H2 Heading - blank line before and after, capitalize first word only
21
21
22
-
1.Ordered lists all all numbered 1.
22
+
1.Number all ordered list items as `1.`
23
23
1. The build process will number them correctly.
24
-
1. Single spafce after the number. Blank line before and after list.
24
+
1. Single spafce after the number.
25
+
1. Blank line before and after list.
25
26
26
-
### H3
27
+
##Unordered lists
27
28
28
-
-Unordered lists use dashes.
29
-
-One space after the dash.
30
-
-Blank line before and after list.
29
+
-Use dashes in unordered lists.
30
+
-Add one space after the dash.
31
+
-Add a blank line before and after list.
31
32
32
33
## Code Samples
33
34
34
-
For formatting and code coloring, wrap code samples in the following format.
35
-
Replace the `xml` with the file extension of the code sample type. Use `bash` for command-line text.
35
+
For formatting and code coloring, wrap code samples in the following format:
36
+
Replace the `xml` with the corresponding language (tupe) of the code sample. Use `bash` for shell commands and `terminal` for terminal output.
36
37
37
38
```xml
38
39
<xmlSample>
@@ -48,12 +49,12 @@ Replace the `xml` with the file extension of the code sample type. Use `bash` fo
48
49
| Colume 1 text | Column 2 text|
49
50
| Column 1 text | Column 2 text|
50
51
51
-
Markdown tables work for simple tables. If you need lists or other complex features within a cell, you may have to use a HTML table.
52
+
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
53
54
## Other tips
54
55
55
56
- Use spaces instead of tabs.
56
-
-One empty line between content. No duplicate empty lines.
57
+
-Do not duplicate blank lines.
57
58
- Read more about how to [Contribute to Magento Devdocs][]
58
59
59
60
<!-- 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. >
0 commit comments