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 info about PasswordStrengthIndicator widget #4733

Merged
merged 18 commits into from Jul 22, 2019

Conversation

VitaliyBoyko
Copy link

@VitaliyBoyko VitaliyBoyko commented Jun 12, 2019

@devops-devdocs
Copy link
Collaborator

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

@rogyar rogyar self-assigned this Jun 12, 2019
@rogyar rogyar added Waiting for Response Waiting for response from internal/external parties 2.1.x 2.2.x 2.3.x Magento 2.3 related changes New Topic A major update published as an entirely new document labels Jun 12, 2019
@rogyar
Copy link
Contributor

rogyar commented Jun 12, 2019

Hi @VitaliyBoyko. Thank you for your collaboration. Please, adjust the changes according to the review comments for both versions. Thank you

@jeff-matthews jeff-matthews added this to Backlog in Processing PRs via automation Jun 16, 2019
@erikmarr erikmarr self-assigned this Jun 17, 2019
@VitaliyBoyko
Copy link
Author

Hi @rogyar
I've updated the PR according to your suggestions. Thank you for the review!

Copy link
Contributor

@erikmarr erikmarr left a comment

Choose a reason for hiding this comment

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

@VitaliyBoyko this looks really good! Just some editorial feedback.


## Overview {#password_strength_indicator_overview}

Magento password strength indicator {% glossarytooltip f0dcf847-ce21-4b88-8b45-83e1cbf08100 %}widget{% endglossarytooltip %} show the user immediate feedback on the validity and strength of a password while it is being typed.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Magento password strength indicator {% glossarytooltip f0dcf847-ce21-4b88-8b45-83e1cbf08100 %}widget{% endglossarytooltip %} show the user immediate feedback on the validity and strength of a password while it is being typed.
The Magento password strength indicator {% glossarytooltip f0dcf847-ce21-4b88-8b45-83e1cbf08100 %}widget{% endglossarytooltip %} provides immediate feedback on the validity and strength of a password while it is being typed.

## Overview {#password_strength_indicator_overview}

Magento password strength indicator {% glossarytooltip f0dcf847-ce21-4b88-8b45-83e1cbf08100 %}widget{% endglossarytooltip %} show the user immediate feedback on the validity and strength of a password while it is being typed.
If the password is not strong enough the UI asks the user to choose a new password.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If the password is not strong enough the UI asks the user to choose a new password.
If the password is not strong enough, Magento prompts the user to choose a new password.


## Events {#password_strength_indicator_events}

The password strength indicator widget listens `change`, `keyup` and `paste` events on the password and the email inputs. Listening to the email input is optional.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The password strength indicator widget listens `change`, `keyup` and `paste` events on the password and the email inputs. Listening to the email input is optional.
The password strength indicator widget listens for `change`, `keyup` and `paste` events on the password and the email inputs. Listening to the email input is optional.

});
```

For details about how to initialize the widget in a`.phtml` template, refer to the [JavaScript initialization] topic.
Copy link
Contributor

Choose a reason for hiding this comment

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


## Events {#password_strength_indicator_events}

The password strength indicator widget listens `change`, `keyup` and `paste` events on the password input.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The password strength indicator widget listens `change`, `keyup` and `paste` events on the password input.
The password strength indicator widget listens for `change`, `keyup`, and `paste` events on the password input.

});
```

For details about how to initialize the widget in a`.phtml` template, refer to the [JavaScript initialization] topic.
Copy link
Contributor

Choose a reason for hiding this comment

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


## Overview {#password_strength_indicator_overview}

Magento password strength indicator {% glossarytooltip f0dcf847-ce21-4b88-8b45-83e1cbf08100 %}widget{% endglossarytooltip %} show the user immediate feedback on the validity and strength of a password while it is being typed.
Copy link
Contributor

Choose a reason for hiding this comment

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

The Magento password strength indicator {% glossarytooltip f0dcf847-ce21-4b88-8b45-83e1cbf08100 %}widget{% endglossarytooltip %} provides immediate feedback on the validity and strength of a password while it is being typed.

## Overview {#password_strength_indicator_overview}

Magento password strength indicator {% glossarytooltip f0dcf847-ce21-4b88-8b45-83e1cbf08100 %}widget{% endglossarytooltip %} show the user immediate feedback on the validity and strength of a password while it is being typed.
If the password is not strong enough the UI asks the user to choose a new password.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If the password is not strong enough the UI asks the user to choose a new password.
If the password is not strong enough, Magento prompts the user to choose a new password.


### Result

The result is a user aware of typed password strength and prevented from using weak one.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The result is a user aware of typed password strength and prevented from using weak one.
The result is an indication of the strength of the user's password.

Processing PRs automation moved this from Backlog to Needs writer approval Jun 18, 2019
@dobooth
Copy link
Contributor

dobooth commented Jul 8, 2019

Hi @VitaliyBoyko Thanks for the PR. In the time between your submitting this PR and now, we stopped supporting v2.1. Therefore, we can't accept any changes to that version. If you update your branch and remove the 2.1 file from this PR and keep the changes in 2.2 and 2.3, we can merge it.

@@ -21,6 +21,7 @@ This guide discusses the following widgets:
- [Menu widget]
- [Modal widget]
- [Navigation widget]
- [PasswordStrengthIndicator widget]
Copy link
Contributor

Choose a reason for hiding this comment

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

Please remove changes to the 2.1 version. You should make these in the 2.2 version.

Processing PRs automation moved this from Needs writer approval to Needs Jenkins testing Jul 19, 2019
Copy link
Contributor

@erikmarr erikmarr left a comment

Choose a reason for hiding this comment

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

Looks good @VitaliyBoyko!

@erikmarr
Copy link
Contributor

running tests

@erikmarr
Copy link
Contributor

Hi @VitaliyBoyko I think we should add an entry to the 2.2 version of the widgets topic, but wanted to confirm with you:
https://devdocs.magento.com/guides/v2.2/javascript-dev-guide/widgets/jquery-widgets-about.html

@VitaliyBoyko
Copy link
Author

VitaliyBoyko commented Jul 19, 2019

Hi @erikmarr
Yes. I have totally forgotten that the 2.2 version is symlinked.

And it seems like I had an outdated branch.

@erikmarr
Copy link
Contributor

Hi @VitaliyBoyko thanks for all your help with this topic! We need one more change before I can get this merged in. Can you create a symlink for the guides/v2.3 version to your new v2.2 topic:
https://devdocs.magento.com/guides/v2.2/javascript-dev-guide/widgets/widget_password_strength_indicator.html
We had some issues because our link checker is expecting that 2.3 topic to exist but we don't have a symlink.

@erikmarr
Copy link
Contributor

running tests

Processing PRs automation moved this from Needs Jenkins testing to Needs writer approval Jul 19, 2019
@erikmarr
Copy link
Contributor

running tests

Processing PRs automation moved this from Needs writer approval to Needs Jenkins testing Jul 19, 2019
@erikmarr
Copy link
Contributor

running tests

@erikmarr
Copy link
Contributor

Hi @VitaliyBoyko there's something wrong with the symlink. Can you run these commands:
unlink guides/v2.3/javascript-dev-guide/widgets/widget_password_strength_indicator.md
then
ln -s ../../../../guides/v2.2/javascript-dev-guide/widgets/widget_password_strength_indicator.md guides/v2.3/javascript-dev-guide/widgets/widget_password_strength_indicator.md

Sorry for all the back and forth on this PR! We appreciate your help.

@erikmarr
Copy link
Contributor

tested locally and this change looks good! Will run tests and merge.

@erikmarr
Copy link
Contributor

running tests

@erikmarr erikmarr merged commit a595258 into magento:master Jul 22, 2019
Processing PRs automation moved this from Needs Jenkins testing to Done Jul 22, 2019
@ghost
Copy link

ghost commented Jul 22, 2019

Hi @VitaliyBoyko, 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.

@erikmarr
Copy link
Contributor

Thanks @VitaliyBoyko!

@erikmarr erikmarr removed 2.1.x Waiting for Response Waiting for response from internal/external parties labels Jul 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

6 participants