From 6c9c34d4f00931860a89e49ff859842f03913e20 Mon Sep 17 00:00:00 2001 From: Donald Booth Date: Mon, 1 Apr 2019 11:22:28 -0500 Subject: [PATCH 01/63] Updating contribution guides for docs. --- .github/CONTRIBUTING.md | 4 +- .github/DOCUMENTATION_TEMPLATE.md | 64 +++++++++++++++++++++++++++++++ 2 files changed, 66 insertions(+), 2 deletions(-) create mode 100644 .github/DOCUMENTATION_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 61805aafe..e5e0cdf3f 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -40,7 +40,7 @@ All contributors are required to submit a click-through form to agree to the ter - Unit/integration test coverage - Proposed documentation update. - For the documentation contribution guidelines, see [DevDocs Contributing][devdocs]. + For the documentation contribution guidelines, see [DOCUMENTATION_TEMPLATE][]. 7. For large features or changes, [open an issue][issue] to discuss first. This may prevent duplicate or unnecessary effort, and it may gain you some additional contributors. 8. To report a bug, [open an issue][issue], and follow [guidelines about bugfix issues][issue reporting]. @@ -160,7 +160,7 @@ Label| Description [create issue]: https://help.github.com/articles/creating-an-issue/ [create pr]: https://help.github.com/articles/creating-a-pull-request/ [Definition of Done]: https://devdocs.magento.com/guides/v2.2/contributor-guide/contributing_dod.html -[devdocs]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.html +[DOCUMENTATION_TEMPLATE]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.html [existing issues]: https://github.com/magento/magento2-functional-testing-framework/issues?q=is%3Aopen+is%3Aissue [existing PRs]: https://github.com/magento/magento2-functional-testing-framework/pulls?q=is%3Aopen+is%3Apr [GitHub documentation]: https://help.github.com/articles/syncing-a-fork diff --git a/.github/DOCUMENTATION_TEMPLATE.md b/.github/DOCUMENTATION_TEMPLATE.md new file mode 100644 index 000000000..db01a3b3c --- /dev/null +++ b/.github/DOCUMENTATION_TEMPLATE.md @@ -0,0 +1,64 @@ +# How to conttribute to MFTF docs + +MFTF documentation is kept within the /docs/ folder in this repo. +We welcome contributions to the documentation. +This page describes the process for submitting docs and serves as a template so that docs are written properly. + +The contribution workflow for docs is the same as submitting code. +To contribute to MFTF docs: + +1. Make a branch from the [MFTF repo][]. +1. Make edits/additions/deletions as needed. +1. Submit your PR to the `develop` branch. + +Once submitted, it will be reviewed by a member of the documentation team. +If approved it will be tested and merged. +If it needs any work, we will inform you. + +Any changes to the Table of Contents will need to be made in the regular [devdocs repo][]. + +## H2 heading - blank line before and after, capitalize first word only + +1. Ordered lists all all numbered 1. +1. The build process will number them correctly. +1. Single spafce after the number. Blank line before and after list. + +### H3 + +- Unordered lists use dashes. +- One space after the dash. +- Blank line before and after list. + +## Code Samples + +For formatting and code coloring, wrap code samples in the following format. +Replace the `xml` with the file extension of the code sample type. Use `bash` for command-line text. + +```xml + + ... + ... + +``` + +## Markdown tables + +| Header | Header | +| ----------- | ----------- | +| Colume 1 text | Column 2 text| +| Column 1 text | Column 2 text| + +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. + +## Other tips + +- Use spaces instead of tabs. +- One empty line between content. No duplicate empty lines. +- Read more about how to [Contribute to Magento Devdocs][] + + +[devdocs repo]: https://github.com/magento/devdocs +[MFTF repo]: https://github.com/magento/magento2-functional-testing-framework +[Contribute to Magento Devdocs]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md \ No newline at end of file From 0c43a9e9fa7988c4241656c79cc2cb4cc0209517 Mon Sep 17 00:00:00 2001 From: Dmitry Shevtsov <12731225+dshevtsov@users.noreply.github.com> Date: Tue, 2 Apr 2019 12:06:32 -0500 Subject: [PATCH 02/63] Update .github/CONTRIBUTING.md Co-Authored-By: dobooth --- .github/CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e5e0cdf3f..24dc3b467 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -160,7 +160,7 @@ Label| Description [create issue]: https://help.github.com/articles/creating-an-issue/ [create pr]: https://help.github.com/articles/creating-a-pull-request/ [Definition of Done]: https://devdocs.magento.com/guides/v2.2/contributor-guide/contributing_dod.html -[DOCUMENTATION_TEMPLATE]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.html +[DOCUMENTATION_TEMPLATE]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md [existing issues]: https://github.com/magento/magento2-functional-testing-framework/issues?q=is%3Aopen+is%3Aissue [existing PRs]: https://github.com/magento/magento2-functional-testing-framework/pulls?q=is%3Aopen+is%3Apr [GitHub documentation]: https://help.github.com/articles/syncing-a-fork @@ -171,4 +171,4 @@ Label| Description [Magento Contributor Agreement]: http://www.magento.com/legaldocuments/mca [MFTF repository]: https://github.com/magento/magento2-functional-testing-framework [open new issue]: https://github.com/magento/magento2-functional-testing-framework/issues/new -[Travis CI]: https://travis-ci.com/magento/magento2-functional-testing-framework/pull_requests \ No newline at end of file +[Travis CI]: https://travis-ci.com/magento/magento2-functional-testing-framework/pull_requests From 5569b0a587f2f2d46739d79caef15d28b151b574 Mon Sep 17 00:00:00 2001 From: Dmitry Shevtsov <12731225+dshevtsov@users.noreply.github.com> Date: Tue, 2 Apr 2019 12:07:21 -0500 Subject: [PATCH 03/63] Update .github/DOCUMENTATION_TEMPLATE.md Co-Authored-By: dobooth --- .github/DOCUMENTATION_TEMPLATE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/DOCUMENTATION_TEMPLATE.md b/.github/DOCUMENTATION_TEMPLATE.md index db01a3b3c..61e06e213 100644 --- a/.github/DOCUMENTATION_TEMPLATE.md +++ b/.github/DOCUMENTATION_TEMPLATE.md @@ -1,6 +1,6 @@ # How to conttribute to MFTF docs -MFTF documentation is kept within the /docs/ folder in this repo. +MFTF documentation is kept within the /docs/ folder in this repository. We welcome contributions to the documentation. This page describes the process for submitting docs and serves as a template so that docs are written properly. @@ -61,4 +61,4 @@ Markdown tables work for simple tables. If you need lists or other complex featu [devdocs repo]: https://github.com/magento/devdocs [MFTF repo]: https://github.com/magento/magento2-functional-testing-framework -[Contribute to Magento Devdocs]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md \ No newline at end of file +[Contribute to Magento Devdocs]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md From 2cc566698ebd3ad88cd93b699acc0237f98ac17f Mon Sep 17 00:00:00 2001 From: Dmitry Shevtsov <12731225+dshevtsov@users.noreply.github.com> Date: Tue, 2 Apr 2019 12:07:55 -0500 Subject: [PATCH 04/63] Update .github/DOCUMENTATION_TEMPLATE.md Co-Authored-By: dobooth --- .github/DOCUMENTATION_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/DOCUMENTATION_TEMPLATE.md b/.github/DOCUMENTATION_TEMPLATE.md index 61e06e213..a678aaf88 100644 --- a/.github/DOCUMENTATION_TEMPLATE.md +++ b/.github/DOCUMENTATION_TEMPLATE.md @@ -2,7 +2,7 @@ MFTF documentation is kept within the /docs/ folder in this repository. We welcome contributions to the documentation. -This page describes the process for submitting docs and serves as a template so that docs are written properly. +This page describes the process for submitting documentation and serves as a template for a properly written content. The contribution workflow for docs is the same as submitting code. To contribute to MFTF docs: From 2290e2ecff1e76ae2a7390f1f22f32ffa4789ec4 Mon Sep 17 00:00:00 2001 From: Donald Booth Date: Tue, 2 Apr 2019 12:25:14 -0500 Subject: [PATCH 05/63] Fixes per review. --- .github/DOCUMENTATION_TEMPLATE.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/.github/DOCUMENTATION_TEMPLATE.md b/.github/DOCUMENTATION_TEMPLATE.md index a678aaf88..1171901ac 100644 --- a/.github/DOCUMENTATION_TEMPLATE.md +++ b/.github/DOCUMENTATION_TEMPLATE.md @@ -4,35 +4,36 @@ MFTF documentation is kept within the /docs/ folder in this repository. We welcome contributions to the documentation. This page describes the process for submitting documentation and serves as a template for a properly written content. -The contribution workflow for docs is the same as submitting code. +The contribution workflow for the Magento functional testing framework (MFTF) documentation is the same as submitting code. To contribute to MFTF docs: -1. Make a branch from the [MFTF repo][]. +1. Make a branch from the `develop` branch in the [MFTF repo][]. 1. Make edits/additions/deletions as needed. 1. Submit your PR to the `develop` branch. -Once submitted, it will be reviewed by a member of the documentation team. +Once submitted, a member of the documentation team will review and merge it. If approved it will be tested and merged. If it needs any work, we will inform you. Any changes to the Table of Contents will need to be made in the regular [devdocs repo][]. -## H2 heading - blank line before and after, capitalize first word only +## H2 Heading - blank line before and after, capitalize first word only -1. Ordered lists all all numbered 1. +1. Number all ordered list items as `1.` 1. The build process will number them correctly. -1. Single spafce after the number. Blank line before and after list. +1. Single spafce after the number. +1. Blank line before and after list. -### H3 +## Unordered lists -- Unordered lists use dashes. -- One space after the dash. -- Blank line before and after list. +- Use dashes in unordered lists. +- Add one space after the dash. +- Add a blank line before and after list. ## Code Samples -For formatting and code coloring, wrap code samples in the following format. -Replace the `xml` with the file extension of the code sample type. Use `bash` for command-line text. +For formatting and code coloring, wrap code samples in the following format: +Replace the `xml` with the corresponding language (tupe) of the code sample. Use `bash` for shell commands and `terminal` for terminal output. ```xml @@ -48,12 +49,12 @@ Replace the `xml` with the file extension of the code sample type. Use `bash` fo | Colume 1 text | Column 2 text| | Column 1 text | Column 2 text| -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. +Markdown formatting works for simple tables. It does not support multiline content within a cell, or split/merged cells within a row or column. ## Other tips - Use spaces instead of tabs. -- One empty line between content. No duplicate empty lines. +- Do not duplicate blank lines. - Read more about how to [Contribute to Magento Devdocs][] -[devdocs repo]: https://github.com/magento/devdocs +[devdocs repo]: https://github.com/magento/devdocs/blob/master/_data/toc/mftf.yml [MFTF repo]: https://github.com/magento/magento2-functional-testing-framework [Contribute to Magento Devdocs]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md +[MFTF documentation]: https://devdocs.magento.com/mftf/docs/introduction.html From d0fd11b3dc337adb35e3a3f6db1a70f16a498fdf Mon Sep 17 00:00:00 2001 From: Donald Booth Date: Mon, 15 Apr 2019 13:36:16 -0500 Subject: [PATCH 16/63] Cleaned up header --- .github/DOCUMENTATION_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/DOCUMENTATION_TEMPLATE.md b/.github/DOCUMENTATION_TEMPLATE.md index 96f8c6bf9..ea5910c91 100644 --- a/.github/DOCUMENTATION_TEMPLATE.md +++ b/.github/DOCUMENTATION_TEMPLATE.md @@ -16,7 +16,7 @@ We will inform you if it needs any additional processing. The documentation in this repository is used as the source for the [MFTF documentation][]. Any changes to the Table of Contents will need to be made via a separate PR in the regular [devdocs repo][]. -## Ordered lists - all heading have a blank line before and after, capitalize the first word only +## Ordered lists 1. Number all ordered list items as `1.` 1. Single space after the number. From 0b2373413c691efd83750c0cd7dda139bc036e85 Mon Sep 17 00:00:00 2001 From: Donald Booth Date: Tue, 16 Apr 2019 09:41:50 -0500 Subject: [PATCH 17/63] Grammar fix. --- .github/DOCUMENTATION_TEMPLATE.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/DOCUMENTATION_TEMPLATE.md b/.github/DOCUMENTATION_TEMPLATE.md index ea5910c91..0afecad9e 100644 --- a/.github/DOCUMENTATION_TEMPLATE.md +++ b/.github/DOCUMENTATION_TEMPLATE.md @@ -6,7 +6,7 @@ This page describes the process for submitting documentation and serves as a tem The contribution workflow for the Magento functional testing framework (MFTF) documentation is the same as submitting code. -1. Create a branch from the `develop` branch in the [MFTF repo][]. +1. Create a branch from the `develop` branch in the [MFTF repository][]. 1. Make edits/additions/deletions as needed. 1. Submit your PR to the `develop` branch. @@ -14,7 +14,7 @@ Once submitted, a member of the documentation team will review and merge it. We will inform you if it needs any additional processing. The documentation in this repository is used as the source for the [MFTF documentation][]. -Any changes to the Table of Contents will need to be made via a separate PR in the regular [devdocs repo][]. +Any changes to the Table of Contents will need to be made via a separate PR in the regular [Magento Developer documentation repository][]. ## Ordered lists @@ -60,7 +60,7 @@ Markdown formatting works for simple tables. It does not support multiline conte -[devdocs repo]: https://github.com/magento/devdocs/blob/master/_data/toc/mftf.yml -[MFTF repo]: https://github.com/magento/magento2-functional-testing-framework +[Magento Developer documentation repository]: https://github.com/magento/devdocs/blob/master/_data/toc/mftf.yml +[MFTF repository]: https://github.com/magento/magento2-functional-testing-framework [Contribute to Magento Devdocs]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md [MFTF documentation]: https://devdocs.magento.com/mftf/docs/introduction.html From 70e59a520d1b774536a8340d0aed93d43792a064 Mon Sep 17 00:00:00 2001 From: Donald Booth Date: Mon, 22 Apr 2019 09:16:26 -0500 Subject: [PATCH 18/63] Fixed grammar. --- .github/DOCUMENTATION_TEMPLATE.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/.github/DOCUMENTATION_TEMPLATE.md b/.github/DOCUMENTATION_TEMPLATE.md index 0afecad9e..fb39105aa 100644 --- a/.github/DOCUMENTATION_TEMPLATE.md +++ b/.github/DOCUMENTATION_TEMPLATE.md @@ -1,10 +1,8 @@ # How to contribute to MFTF docs -MFTF documentation is kept within the /docs/ folder in this repository. -We welcome contributions to the documentation. -This page describes the process for submitting documentation and serves as a template for a properly written content. - -The contribution workflow for the Magento functional testing framework (MFTF) documentation is the same as submitting code. +We welcome contributions to the MFTF documentation, which is kept within the /docs/ folder in this repository. +This page describes the submitting process and serves as a template for a properly written content. +The contribution workflow is the same as submitting code. 1. Create a branch from the `develop` branch in the [MFTF repository][]. 1. Make edits/additions/deletions as needed. @@ -14,7 +12,7 @@ Once submitted, a member of the documentation team will review and merge it. We will inform you if it needs any additional processing. The documentation in this repository is used as the source for the [MFTF documentation][]. -Any changes to the Table of Contents will need to be made via a separate PR in the regular [Magento Developer documentation repository][]. +Any changes to the table of contents will need to be made through a separate pull request in the regular [Magento Developer documentation repository][]. ## Ordered lists From 2eef763920df78d96ee25000ecadb9f20359fd72 Mon Sep 17 00:00:00 2001 From: Donald Booth Date: Mon, 29 Apr 2019 15:51:28 -0700 Subject: [PATCH 19/63] Indenting so markdown syntax shows. --- .github/DOCUMENTATION_TEMPLATE.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/.github/DOCUMENTATION_TEMPLATE.md b/.github/DOCUMENTATION_TEMPLATE.md index fb39105aa..8a5a7d65e 100644 --- a/.github/DOCUMENTATION_TEMPLATE.md +++ b/.github/DOCUMENTATION_TEMPLATE.md @@ -31,12 +31,13 @@ Any changes to the table of contents will need to be made through a separate pul For technical words such as a database table name, wrap with single backticks: `tablename`. For code block highlighting, wrap code samples in the following format: -```xml - - ... - ... - -``` + + ```xml + + ... + ... + + ``` Replace the `xml` with the corresponding language (tupe) of the code sample. Use `bash` for shell commands and `terminal` for terminal output. From 42bc8d160744019857edbcf3b354dde9c8b32970 Mon Sep 17 00:00:00 2001 From: Donald Booth Date: Mon, 29 Apr 2019 15:51:57 -0700 Subject: [PATCH 20/63] Indenting so markdown syntax shows. From 51d66ebdf39ae9e9bcc5f09f1155143747350f0d Mon Sep 17 00:00:00 2001 From: Donald Booth Date: Mon, 29 Apr 2019 15:58:47 -0700 Subject: [PATCH 21/63] Linked to Basic Template. --- .github/DOCUMENTATION_TEMPLATE.md | 45 +++---------------------------- 1 file changed, 3 insertions(+), 42 deletions(-) diff --git a/.github/DOCUMENTATION_TEMPLATE.md b/.github/DOCUMENTATION_TEMPLATE.md index 8a5a7d65e..f7e6a8576 100644 --- a/.github/DOCUMENTATION_TEMPLATE.md +++ b/.github/DOCUMENTATION_TEMPLATE.md @@ -5,7 +5,7 @@ This page describes the submitting process and serves as a template for a proper The contribution workflow is the same as submitting code. 1. Create a branch from the `develop` branch in the [MFTF repository][]. -1. Make edits/additions/deletions as needed. +1. Make edits/additions/deletions as needed. Read the [Basic Template][] for tips on how to write with Markdown. 1. Submit your PR to the `develop` branch. Once submitted, a member of the documentation team will review and merge it. @@ -14,47 +14,7 @@ We will inform you if it needs any additional processing. The documentation in this repository is used as the source for the [MFTF documentation][]. Any changes to the table of contents will need to be made through a separate pull request in the regular [Magento Developer documentation repository][]. -## Ordered lists - -1. Number all ordered list items as `1.` -1. Single space after the number. -1. Blank line before and after list. - -## Unordered lists - -- Use dashes in unordered lists. -- Add one space after the dash. -- Add a blank line before and after list. - -## Code samples - -For technical words such as a database table name, wrap with single backticks: `tablename`. -For code block highlighting, wrap code samples in the following format: - - - ```xml - - ... - ... - - ``` - -Replace the `xml` with the corresponding language (tupe) of the code sample. Use `bash` for shell commands and `terminal` for terminal output. - -## Markdown tables - -| Header | Header | -| ----------- | ----------- | -| Column 1 text | Column 2 text| -| Column 1 text | Column 2 text| - -Markdown formatting works for simple tables. It does not support multiline content within a cell, or split/merged cells within a row or column. - -## Other tips - -- Use spaces instead of tabs. -- Do not duplicate blank lines. -- Read more about how to [Contribute to Magento Devdocs][] +Read more about how to [Contribute to Magento Devdocs][].