docs(step_15): create new step about accessibility #14779

felixzapata · 2016-06-15T09:03:18Z

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Docs update to add a new step about accessibility

What is the current behavior? (You can also link to an open issue here)
The current tutorial is not accessible. With this new step you can learn how to fix the issues.

What is the new behavior (if this is a feature change)?
Introduce the accessibility into the tutorial.

Does this PR introduce a breaking change?
No, it does'nt. Only affects to the tutorial.

Please check if the PR fulfills these requirements

The commit message follows our guidelines: https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit-message-format
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

Other information:
My opinion is this step should be a process inside of the tutorial. Not a separate step. This way the user can understand that is optional but it should be mandatory.

gkalpak · 2016-06-20T13:53:36Z

fyi @marcysutton

gkalpak · 2016-06-20T13:57:39Z

docs/content/tutorial/step_15.ngdoc

+<div doc-tutorial-reset="15"></div>
+
+## Why accessibility matters
+


Could you add a paragraph on what is "accessibility" and "aria" and how it affects people. Just a brief summary and then list the links for more info.

ok, I'm on it.

I've added some definitions.

gkalpak · 2016-06-20T14:17:59Z

I left a few comments. Overall looks good 👍

A couple more necessary changes:

Limit lines to 100 chars max.
Don't mention anything protractor-related until the "Testing" section (except for the step summary at the top).
I would rather not introduce new features at this point. Custom directives, $scope.$watch etc, are not explained before. Are they necessary?

felixzapata · 2016-06-20T14:52:20Z

For this example, I think is better the directives rather to use a component. These directives are needed to intercept the repeater and return the values to the aria regions. Maybe this can do it in another way.

Another option would be to remove the section "How to use the directives" and add a link to the Directives webpage.

add definitions about accessibility and WAI-ARIA ngAria module now is not neccesary, so the section has been moved to explain how to use it if you need it explain how to fix the problem with the keyboard in the detail page.

felixzapata · 2016-06-21T08:13:18Z

@gkalpak I've made some updates. I will ping you, when I complete all of them (limit of lines, explanation of protractor accessibility plugin).

marcysutton · 2016-06-21T17:56:38Z

docs/content/tutorial/step_15.ngdoc

+* [Accessibility in AngularJS and Beyond](http://marcysutton.com/slides/fluent2015/)
+* [Introduction to Web Accessibility](https://www.w3.org/WAI/intro/accessibility.php)
+* [Apps For All: Coding Accessible Web Applications](https://shop.smashingmagazine.com/products/apps-for-all)
+


Here's one more article that was written in response to Angular a11y: https://www.smashingmagazine.com/2015/05/client-rendered-accessibility/

felixzapata · 2016-06-22T07:23:00Z

@gkalpak the limit of 100 characters is only for the code examples or all the document?

gkalpak · 2016-06-26T11:34:12Z

@felixzapata, the limit is for the whole document (where ever possible, e.g. if a URL is too long it's OK).
Is this ready for another review?

felixzapata · 2016-06-27T06:48:11Z

@gkalpak I have to review about the lines and I have to think what to do with the directives. Have you seen my previous comment about that? I mean, remove the section "How to use the directives" and add a link to the Directives webpage, instead of copy the code of the directives.

remove information about directives. Now the tutorial links to the guide. remove information about how to install ngAria because is not used in this step.

felixzapata · 2016-07-01T07:08:18Z

@gkalpak it is ready for another review:

I've removed the information about directives. Now the tutorial has a link to the directives guide.
I've removed the information about how to instal the ngAria module becuase, finally, is not used in this step.

When the step is approved, I will squash the commits.

felixzapata · 2016-07-18T10:05:48Z

@gkalpak it is ready for another review.

felixzapata · 2016-10-08T09:31:05Z

@gkalpak hi, any news about this pull request?

googlebot · 2016-10-08T09:31:07Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed, please reply here (e.g. I signed it!) and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please let us know the company's name.

googlebot · 2016-10-08T09:31:08Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed, please reply here (e.g. I signed it!) and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please let us know the company's name.

felixzapata · 2016-10-08T09:34:19Z

I signed it!

googlebot · 2016-10-08T09:34:22Z

CLAs look good, thanks!

googlebot · 2016-10-08T09:34:22Z

CLAs look good, thanks!

gkalpak · 2016-10-17T08:02:21Z

Sorry it is taking so long, @felixzapata. It is still on my todo list. I'll get to it after 1.5.9 and 1.6.0-rc.0 are released.

felixzapata · 2016-10-17T19:58:14Z

ok @gkalpak

googlebot added the cla: yes label Jun 15, 2016

felixzapata mentioned this pull request Jun 15, 2016

step-15 Accessibility angular/angular-phonecat#341

Open

petebacondarwin added type: docs needs: review labels Jun 15, 2016

petebacondarwin added this to the 1.5.x milestone Jun 15, 2016

petebacondarwin assigned gkalpak Jun 15, 2016

gkalpak reviewed Jun 20, 2016
View reviewed changes

gkalpak added needs: work and removed needs: review labels Jun 20, 2016

felixzapata added 2 commits June 21, 2016 10:08

docs(step_15): create new step about accessibility

6e9015f

docs(step_15.ngdoc): update the step 15

7103297

add definitions about accessibility and WAI-ARIA ngAria module now is not neccesary, so the section has been moved to explain how to use it if you need it explain how to fix the problem with the keyboard in the detail page.

felixzapata force-pushed the step15-a11y branch from 8a62975 to 7103297 Compare June 21, 2016 08:09

marcysutton reviewed Jun 21, 2016
View reviewed changes

docs(step_15): update document following marcysutton comments

62c5f59

docs(step_15): add more information about the protractor plugin

1300f80

felixzapata added 2 commits June 27, 2016 09:08

docs(step_15): update document

c8c2dfd

docs(step_15): update the doc

6a7b77f

remove information about directives. Now the tutorial links to the guide. remove information about how to install ngAria because is not used in this step.

googlebot added cla: no and removed cla: yes labels Oct 8, 2016

googlebot added cla: yes and removed cla: no labels Oct 8, 2016

Narretz modified the milestones: 1.5.x, 1.7.x Apr 12, 2018

petebacondarwin modified the milestones: 1.7.x, 1.7.x - won't fix Sep 19, 2018

docs(step_15): create new step about accessibility #14779

docs(step_15): create new step about accessibility #14779

felixzapata commented Jun 15, 2016

gkalpak commented Jun 20, 2016

gkalpak Jun 20, 2016

felixzapata Jun 20, 2016

felixzapata Jun 21, 2016

gkalpak commented Jun 20, 2016

felixzapata commented Jun 20, 2016 •

edited

felixzapata commented Jun 21, 2016

marcysutton Jun 21, 2016

felixzapata commented Jun 22, 2016

gkalpak commented Jun 26, 2016

felixzapata commented Jun 27, 2016

felixzapata commented Jul 1, 2016 •

edited

felixzapata commented Jul 18, 2016

felixzapata commented Oct 8, 2016

googlebot commented Oct 8, 2016

googlebot commented Oct 8, 2016

felixzapata commented Oct 8, 2016

googlebot commented Oct 8, 2016

googlebot commented Oct 8, 2016

gkalpak commented Oct 17, 2016

felixzapata commented Oct 17, 2016

		<div doc-tutorial-reset="15"></div>

		## Why accessibility matters

docs(step_15): create new step about accessibility #14779

Are you sure you want to change the base?

docs(step_15): create new step about accessibility #14779

Conversation

felixzapata commented Jun 15, 2016

gkalpak commented Jun 20, 2016

gkalpak Jun 20, 2016

Choose a reason for hiding this comment

felixzapata Jun 20, 2016

Choose a reason for hiding this comment

felixzapata Jun 21, 2016

Choose a reason for hiding this comment

gkalpak commented Jun 20, 2016

felixzapata commented Jun 20, 2016 • edited

felixzapata commented Jun 21, 2016

marcysutton Jun 21, 2016

Choose a reason for hiding this comment

felixzapata commented Jun 22, 2016

gkalpak commented Jun 26, 2016

felixzapata commented Jun 27, 2016

felixzapata commented Jul 1, 2016 • edited

felixzapata commented Jul 18, 2016

felixzapata commented Oct 8, 2016

googlebot commented Oct 8, 2016

googlebot commented Oct 8, 2016

felixzapata commented Oct 8, 2016

googlebot commented Oct 8, 2016

googlebot commented Oct 8, 2016

gkalpak commented Oct 17, 2016

felixzapata commented Oct 17, 2016

felixzapata commented Jun 20, 2016 •

edited

felixzapata commented Jul 1, 2016 •

edited