Skip to content

Commit 2290e2e

Browse files
committed
Fixes per review.
1 parent 2cc5666 commit 2290e2e

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

.github/DOCUMENTATION_TEMPLATE.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,36 @@ MFTF documentation is kept within the /docs/ folder in this repository.
44
We welcome contributions to the documentation.
55
This page describes the process for submitting documentation and serves as a template for a properly written content.
66

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.
88
To contribute to MFTF docs:
99

10-
1. Make a branch from the [MFTF repo][].
10+
1. Make a branch from the `develop` branch in the [MFTF repo][].
1111
1. Make edits/additions/deletions as needed.
1212
1. Submit your PR to the `develop` branch.
1313

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.
1515
If approved it will be tested and merged.
1616
If it needs any work, we will inform you.
1717

1818
Any changes to the Table of Contents will need to be made in the regular [devdocs repo][].
1919

20-
## H2 heading - blank line before and after, capitalize first word only
20+
## H2 Heading - blank line before and after, capitalize first word only
2121

22-
1. Ordered lists all all numbered 1.
22+
1. Number all ordered list items as `1.`
2323
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.
2526

26-
### H3
27+
## Unordered lists
2728

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.
3132

3233
## Code Samples
3334

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.
3637

3738
```xml
3839
<xmlSample>
@@ -48,12 +49,12 @@ Replace the `xml` with the file extension of the code sample type. Use `bash` fo
4849
| Colume 1 text | Column 2 text|
4950
| Column 1 text | Column 2 text|
5051

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.
5253

5354
## Other tips
5455

5556
- Use spaces instead of tabs.
56-
- One empty line between content. No duplicate empty lines.
57+
- Do not duplicate blank lines.
5758
- Read more about how to [Contribute to Magento Devdocs][]
5859

5960
<!-- 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

Comments
 (0)