Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Added documentation about the Breadcrumbs widget #5228

Conversation

serhiyzhovnir
Copy link
Contributor

@serhiyzhovnir serhiyzhovnir commented Aug 21, 2019

Purpose of this pull request

This pull request (PR) adds the documentation about the Breadcrumbs widget.

Affected DevDocs pages

This documentation will have the following links:

Page Look

Breadcrumbs widget documentation page view

Links to Magento source code

whatsnew
Added a new topic about the Breadcrumbs widget.

@devops-devdocs
Copy link
Collaborator

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

@rogyar rogyar added 2.2.x 2.3.x Magento 2.3 related changes New Topic A major update published as an entirely new document Technical Updates to the code or processes that alter the technical content of the doc and removed Progress: changes requested labels Aug 21, 2019
@serhiyzhovnir
Copy link
Contributor Author

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!

@jeff-matthews jeff-matthews removed the Technical Updates to the code or processes that alter the technical content of the doc label Aug 23, 2019
Copy link
Contributor

@jeff-matthews jeff-matthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@serhiyzhovnir
Copy link
Contributor Author

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

Copy link
Contributor

@jeff-matthews jeff-matthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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
Copy link
Contributor Author

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

Copy link
Contributor

@jeff-matthews jeff-matthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirmed. Thanks @serhiyzhovnir.

@jeff-matthews
Copy link
Contributor

running tests

1 similar comment
@jeff-matthews
Copy link
Contributor

running tests

@jeff-matthews
Copy link
Contributor

running tests

@jeff-matthews
Copy link
Contributor

jeff-matthews 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
Copy link
Contributor Author

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

@jeff-matthews
Copy link
Contributor

running tests

@jeff-matthews jeff-matthews merged commit 256e033 into magento:master Aug 26, 2019
@ghost
Copy link

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
2.2.x 2.3.x Magento 2.3 related changes New Topic A major update published as an entirely new document Partner: Atwix partners-contribution PR created by Magento partner
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants