|
| 1 | +# How to conttribute to MFTF docs |
| 2 | + |
| 3 | +MFTF documentation is kept within the /docs/ folder in this repo. |
| 4 | +We welcome contributions to the documentation. |
| 5 | +This page describes the process for submitting docs and serves as a template so that docs are written properly. |
| 6 | + |
| 7 | +The contribution workflow for docs is the same as submitting code. |
| 8 | +To contribute to MFTF docs: |
| 9 | + |
| 10 | +1. Make a branch from the [MFTF repo][]. |
| 11 | +1. Make edits/additions/deletions as needed. |
| 12 | +1. Submit your PR to the `develop` branch. |
| 13 | + |
| 14 | +Once submitted, it will be reviewed by a member of the documentation team. |
| 15 | +If approved it will be tested and merged. |
| 16 | +If it needs any work, we will inform you. |
| 17 | + |
| 18 | +Any changes to the Table of Contents will need to be made in the regular [devdocs repo][]. |
| 19 | + |
| 20 | +## H2 heading - blank line before and after, capitalize first word only |
| 21 | + |
| 22 | +1. Ordered lists all all numbered 1. |
| 23 | +1. The build process will number them correctly. |
| 24 | +1. Single spafce after the number. Blank line before and after list. |
| 25 | + |
| 26 | +### H3 |
| 27 | + |
| 28 | +- Unordered lists use dashes. |
| 29 | +- One space after the dash. |
| 30 | +- Blank line before and after list. |
| 31 | + |
| 32 | +## Code Samples |
| 33 | + |
| 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. |
| 36 | + |
| 37 | +```xml |
| 38 | +<xmlSample> |
| 39 | + ... |
| 40 | + ... |
| 41 | +</xmlSample> |
| 42 | +``` |
| 43 | + |
| 44 | +## Markdown tables |
| 45 | + |
| 46 | +| Header | Header | |
| 47 | +| ----------- | ----------- | |
| 48 | +| Colume 1 text | Column 2 text| |
| 49 | +| Column 1 text | Column 2 text| |
| 50 | + |
| 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 | + |
| 53 | +## Other tips |
| 54 | + |
| 55 | +- Use spaces instead of tabs. |
| 56 | +- One empty line between content. No duplicate empty lines. |
| 57 | +- Read more about how to [Contribute to Magento Devdocs][] |
| 58 | + |
| 59 | +<!-- 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 | +
|
| 61 | +<!-- Link Definitions --> |
| 62 | +[devdocs repo]: https://github.com/magento/devdocs |
| 63 | +[MFTF repo]: https://github.com/magento/magento2-functional-testing-framework |
| 64 | +[Contribute to Magento Devdocs]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md |
0 commit comments