Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adjusted Loader widget documentation #5230

Merged

Conversation

@serhiyzhovnir
Copy link
Contributor

commented Aug 21, 2019

Purpose of this pull request

This pull request (PR) improves the documentation about Loader widget.

Improvements:

  • Added examples of the widget initialization
  • Added examples of adding callbacks to processStart and processStop events
  • Added Code Sample and Result sections
  • Also, adjusted the markup

Affected DevDocs pages

Links to Magento source code

whatsnew
Added new code examples to the Loader widget topic.

@devops-devdocs

This comment has been minimized.

Copy link

commented Aug 21, 2019

An admin must run tests on this PR before it can be merged.

@rogyar rogyar self-assigned this Aug 21, 2019

@m2-community-project m2-community-project bot moved this from Ready for Review to Review in Progress in Pull Request Progress Aug 21, 2019

Adjusted the loader documentation
Co-Authored-By: Yaroslav Rogoza <enarc@atwix.com>
@serhiyzhovnir

This comment has been minimized.

Copy link
Contributor Author

commented Aug 21, 2019

@rogyar The requested changes were added.
Thank you!

@rogyar
rogyar approved these changes Aug 22, 2019
@rogyar

This comment has been minimized.

Copy link
Contributor

commented Aug 22, 2019

Hi @serhiyzhovnir. Please, take a look at the conflicts with the mainline.
Thank you

@serhiyzhovnir

This comment has been minimized.

Copy link
Contributor Author

commented Aug 22, 2019

Hi @rogyar
The conflict is resolved.
Thank you!

@serhiyzhovnir

This comment has been minimized.

Copy link
Contributor Author

commented Aug 23, 2019

Hi @jeff-matthews
The required changes were added.
Please, check the PR.
Thank you!

@jeff-matthews
Copy link
Contributor

left a comment

Thanks @serhiyzhovnir!

@jeff-matthews

This comment has been minimized.

Copy link
Contributor

commented Aug 23, 2019

running tests

@jeff-matthews

This comment has been minimized.

Copy link
Contributor

commented Aug 23, 2019

Tests failed due to markdown style rule violations. @serhiyzhovnir, please fix the following issues:

+ rake test:cicd
�[35mTesting Markdown style with mdl ...�[0m
�[31mThe Markdown linter has found 8 issues�[0m
�[33mguides/v2.2/javascript-dev-guide/widgets/widget_loader.md:9: MD009 Trailing spaces
guides/v2.2/javascript-dev-guide/widgets/widget_loader.md:50: MD009 Trailing spaces
guides/v2.2/javascript-dev-guide/widgets/widget_loader.md:58: MD009 Trailing spaces
guides/v2.3/javascript-dev-guide/widgets/widget_loader.md:9: MD009 Trailing spaces
guides/v2.3/javascript-dev-guide/widgets/widget_loader.md:50: MD009 Trailing spaces
guides/v2.3/javascript-dev-guide/widgets/widget_loader.md:58: MD009 Trailing spaces

A detailed description of the rules is available at https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
@jeff-matthews
Copy link
Contributor

left a comment

Markdown linting failed

@serhiyzhovnir

This comment has been minimized.

Copy link
Contributor Author

commented Aug 25, 2019

Hi @jeff-matthews
We have fixed the issue with failed markdown linting.
Please, check it.
Thank you!

@jeff-matthews jeff-matthews moved this from Changes Requested to Acceptance Testing in Pull Request Progress Aug 26, 2019

@jeff-matthews

This comment has been minimized.

Copy link
Contributor

commented Aug 26, 2019

running tests

@jeff-matthews

This comment has been minimized.

Copy link
Contributor

commented Aug 26, 2019

@serhiyzhovnir, tests failed on image link:

Running ["LinkChecker::DoubleSlashCheck", "HtmlCheck", "ImageCheck", "LinkCheck", "ScriptCheck"] on ["_site"] on *.html... 


Ran on 2803 files!


- internal image /common/images/widget/loader-widget-result.png does not exist
  *  _site/guides/v2.2/javascript-dev-guide/widgets/widget_loader.html (line 424)
  *  _site/guides/v2.3/javascript-dev-guide/widgets/widget_loader.html (line 424)
rake aborted!
HTML-Proofer found 2 failures!``` 
@jeff-matthews
Copy link
Contributor

left a comment

Fix broken link to image

@serhiyzhovnir

This comment has been minimized.

Copy link
Contributor Author

commented Aug 26, 2019

@jeff-matthews
I've added the missed image.
Thank you!

@jeff-matthews

This comment has been minimized.

Copy link
Contributor

commented Aug 26, 2019

running tests

@jeff-matthews jeff-matthews merged commit 7b89085 into magento:master Aug 26, 2019

2 checks passed

Jenkins Tests passed
Details
licence/cla Contributor License Agreement is signed.
Details
@contribution-survey

This comment has been minimized.

Copy link

commented Aug 26, 2019

Hi @serhiyzhovnir, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

@m2-community-project m2-community-project bot moved this from Acceptance Testing to Done in Pull Request Progress Aug 26, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.