Skip to content

Commit 9501614

Browse files
committed
Fixes per review.
1 parent 539a562 commit 9501614

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

.github/DOCUMENTATION_TEMPLATE.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
1-
# How to conttribute to MFTF docs
1+
# How to contribute to MFTF docs
22

33
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

77
The contribution workflow for the Magento functional testing framework (MFTF) documentation is the same as submitting code.
88

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][].
1010
1. Make edits/additions/deletions as needed.
1111
1. Submit your PR to the `develop` branch.
1212

1313
Once submitted, a member of the documentation team will review and merge it.
1414
We will inform you if it needs any additional processing.
1515

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][].
1718

1819
## Ordered lists - all heading have a blank line before and after, capitalize the first word only
1920

2021
1. Number all ordered list items as `1.`
21-
1. Single spafce after the number.
22+
1. Single space after the number.
2223
1. Blank line before and after list.
2324

2425
## Unordered lists
@@ -29,7 +30,8 @@ Any changes to the Table of Contents will need to be made in the regular [devdoc
2930

3031
## Code samples
3132

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:
3335

3436
```xml
3537
<xmlSample>
@@ -44,7 +46,7 @@ Replace the `xml` with the corresponding language (tupe) of the code sample. Use
4446

4547
| Header | Header |
4648
| ----------- | ----------- |
47-
| Colume 1 text | Column 2 text|
49+
| Column 1 text | Column 2 text|
4850
| Column 1 text | Column 2 text|
4951

5052
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
5860
<!-- 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. >
5961
6062
<!-- Link Definitions -->
61-
[devdocs repo]: https://github.com/magento/devdocs
63+
[devdocs repo]: https://github.com/magento/devdocs/blob/master/_data/toc/mftf.yml
6264
[MFTF repo]: https://github.com/magento/magento2-functional-testing-framework
6365
[Contribute to Magento Devdocs]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md
66+
[MFTF documentation]: https://devdocs.magento.com/mftf/docs/introduction.html

0 commit comments

Comments
 (0)