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

Added documentation about the Breadcrumbs widget #5228

Conversation

@serhiyzhovnir
Copy link
Contributor

commented Aug 21, 2019

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

@serhiyzhovnir

This comment has been minimized.

Copy link
Contributor Author

commented Aug 21, 2019

Hi @rogyar
The explanations of title and label attributes were improved.
Also, here is the picture which describes where breadcrumbs item options are used in the HTML template:
https://raw.githubusercontent.com/magento/devdocs/9a435b6526257e9fa5a68cbe5c2dfa126298ca71/common/images/widget/breadcrumb-list-item-html.png
Thank you!

@rogyar
rogyar approved these changes Aug 22, 2019

@m2-community-project m2-community-project bot moved this from Changes Requested to Reviewer Approved in Pull Request Progress Aug 23, 2019

@jeff-matthews
Copy link
Contributor

left a comment

Thanks for the new topic @serhiyzhovnir! I made a few editorial suggestions.

@serhiyzhovnir

This comment has been minimized.

Copy link
Contributor Author

commented Aug 25, 2019

Hi @jeff-matthews
All requested changes were added.
Please, check the PR again.
Thank you!

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

@jeff-matthews
Copy link
Contributor

left a comment

@serhiyzhovnir, I just noticed some markdown syntax errors in your branch that will fail tests. Please fix the following issues so I can finish processing your PR.

rake test:cicd
Testing Markdown style with mdl ...
guides/v2.2/javascript-dev-guide/widgets/widget-breadcrumbs.md:39: MD009 Trailing spaces
guides/v2.2/javascript-dev-guide/widgets/widget-breadcrumbs.md:51: MD009 Trailing spaces
guides/v2.2/javascript-dev-guide/widgets/widget-breadcrumbs.md:130: MD009 Trailing spaces
guides/v2.3/javascript-dev-guide/widgets/widget-breadcrumbs.md:39: MD009 Trailing spaces
guides/v2.3/javascript-dev-guide/widgets/widget-breadcrumbs.md:51: MD009 Trailing spaces
guides/v2.3/javascript-dev-guide/widgets/widget-breadcrumbs.md:130: MD009 Trailing spaces

A detailed description of the rules is available at https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md

The Markdown linter has found 8 issues```
@serhiyzhovnir

This comment has been minimized.

Copy link
Contributor Author

commented Aug 26, 2019

Hi @jeff-matthews
The trailing spaces were removed.
Please, check the PR again.
Thank you!

@jeff-matthews
Copy link
Contributor

left a comment

Confirmed. Thanks @serhiyzhovnir.

@jeff-matthews

This comment has been minimized.

Copy link
Contributor

commented Aug 26, 2019

running tests

1 similar comment
@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

running tests

@jeff-matthews

This comment has been minimized.

Copy link
Contributor

commented Aug 26, 2019

@serhiyzhovnir, tests are failing on links:

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


Ran on 2805 files!


- linking to internal hash #breadcrumb_list that does not exist
  *  _site/guides/v2.2/javascript-dev-guide/widgets/widget-breadcrumbs.html (line 374)
     <a href="#breadcrumb_list">Breadcrumbs list</a>
  *  _site/guides/v2.3/javascript-dev-guide/widgets/widget-breadcrumbs.html (line 374)
     <a href="#breadcrumb_list">Breadcrumbs list</a>
rake aborted!
HTML-Proofer found 2 failures!``` 
@serhiyzhovnir

This comment has been minimized.

Copy link
Contributor Author

commented Aug 26, 2019

@jeff-matthews the issue with the link is fixed.
Thank you!

@jeff-matthews

This comment has been minimized.

Copy link
Contributor

commented Aug 26, 2019

running tests

@jeff-matthews jeff-matthews merged commit 256e033 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.