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
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,24 +1,25 @@
1
-
# How to conttribute to MFTF docs
1
+
# How to contribute to MFTF docs
2
2
3
3
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
7
The contribution workflow for the Magento functional testing framework (MFTF) documentation is the same as submitting code.
8
8
9
-
1.Make a branch from the `develop` branch in the [MFTF repo][].
9
+
1.Create a branch from the `develop` branch in the [MFTF repo][].
10
10
1. Make edits/additions/deletions as needed.
11
11
1. Submit your PR to the `develop` branch.
12
12
13
13
Once submitted, a member of the documentation team will review and merge it.
14
14
We will inform you if it needs any additional processing.
15
15
16
-
Any changes to the Table of Contents will need to be made in the regular [devdocs repo][].
16
+
The documentation in this repository is used as the source for the [MFTF documentation][].
17
+
Any changes to the Table of Contents will need to be made via a separate PR in the regular [devdocs repo][].
17
18
18
19
## Ordered lists - all heading have a blank line before and after, capitalize the first word only
19
20
20
21
1. Number all ordered list items as `1.`
21
-
1. Single spafce after the number.
22
+
1. Single space after the number.
22
23
1. Blank line before and after list.
23
24
24
25
## Unordered lists
@@ -29,7 +30,8 @@ Any changes to the Table of Contents will need to be made in the regular [devdoc
29
30
30
31
## Code samples
31
32
32
-
For code highlighting, wrap code samples in the following format:
33
+
For technical words such as a database table name, wrap with single backticks: `tablename`.
34
+
For code block highlighting, wrap code samples in the following format:
33
35
34
36
```xml
35
37
<xmlSample>
@@ -44,7 +46,7 @@ Replace the `xml` with the corresponding language (tupe) of the code sample. Use
44
46
45
47
| Header | Header |
46
48
| ----------- | ----------- |
47
-
|Colume 1 text | Column 2 text|
49
+
|Column 1 text | Column 2 text|
48
50
| Column 1 text | Column 2 text|
49
51
50
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.
@@ -58,6 +60,7 @@ Markdown formatting works for simple tables. It does not support multiline conte
58
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