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

Tutorial feedback - Using Dojo 1 Dijits #294

Open
umaar opened this issue Oct 20, 2017 · 1 comment
Open

Tutorial feedback - Using Dojo 1 Dijits #294

umaar opened this issue Oct 20, 2017 · 1 comment

Comments

@umaar
Copy link
Member

umaar commented Oct 20, 2017

This feedback is for this tutorial: https://dojo.io/tutorials/1040_dojo1_dijits/


Feedback 1

Step 0: “Dojo 2 based form widgets and with Dojo 1 Dijits”

Should give a basic overview of what a Dojo 1 ‘dijit’ is.


Feedback 2

Step 1: “Install additional development dependency:”

The visual spacing between headers is squashed:


Feedback 3

Step 1: “Install additional development dependency:”
“Dependency” -> “dependencies”


Feedback 4

Step 1: “Install additional development dependency:”

There should be some explanation into what the user is installing exactly.


Feedback 5

Step 2: “Some of the Dojo 1 typings reference typings from this library.”

Rephrase this?


Feedback 6

Step 2: “Add the Dijit module typings to the include section of tsconfig.json:”

This feedback is not specific to this tutorial. However I would prefer the code blocks in tutorials highlighted the line(s) I should be paying attention to so I don’t have to keep going back and forth to the code to understand what’s already present.


Feedback 7

Step 2:

“If you are using your own custom Dijits, you should add your own TypeScript typings to the project. The dojo/typings can provide you examples ”

“The dojo/typings can” -> “The dojo/typings [project/repo/thing] can”


Feedback 8

Step 3: “You should see a rather long output indicating many dependencies have been output.”

Funny usage of the word ‘output’ twice. Maybe ‘indicating many dependencies have been created’ ?


Feedback 9

Step 4: “To integrate Dijits within into a Dojo 2 application”

Grammar issue here, “within into”.


Feedback 10

Step 4: “needs to create a DOM stub to ”

More explanation on what is meant by a DOM stub.


Feedback 11

Step 4: “Now that you have wrapped Dijits for use, we need to import them into their containing Dojo 2 or modules.”

There is a missing term: “into their containing Dojo 2 [missing term here?] or”


Feedback 12

Step 5:

“We will be using w() function”.

“using “ -> “using the”


Feedback 13

Step 5: “ they behave very similar to Dojo 2 widgets”

Would replace this with “ they behave similarly to Dojo 2 widgets”


Feedback 14

Step 5: “Coupled with the dojo-typings TypeScript typings”

A little funny to read, maybe rephrase?


Feedback 15

Step 5: “represent their DOM virtually”

This links to a coming soon page.


Feedback 16

Step 5: “When we configured the externals for our”

Needs clarification, the “externals” what?


Feedback 17

Step 5: “Add theme class name to src/index.html:”

Rephrase this one, bit confusing.


Feedback 18

Step 5: “You should now have an application that will provide you with a form that”

When following along with the tutorial up to this point, I get this error in the console panel:

image

This error is also present in the “completed” demo application. When you create a “new worker”, the new worker does not include the first/last name:

image

I was trying to explore why this might be happening, and noticed if I comment out the parent Fieldset (a dijit) which the first name + last name fields are part of, then the error disappears.

image

The email field does not have this problem.


Feedback 19

Step 6: “In this tutorial, we learned how to setup the build ...”

In this paragraph, there are 3 “we learned” style notes, I think it’d be much clearer as a bullet pointed list.

@matt-gadd
Copy link
Contributor

@umaar i think Feedback 18 was due to this regression in widget-core dojo/widget-core#724.

umaar added a commit to umaar/dojo.io that referenced this issue Oct 23, 2017
dojo#244 Feedback 1
dojo#270 Feedback 1
dojo#258 Feedback 1
dojo#251 Feedback 3
dojo#251 Feedback 4
dojo#250 Feedback 2
dojo#295 Feedback 1
dojo#295 Feedback 5
dojo#294 Feedback 3
dojo#294 Feedback 9
dojo#294 Feedback 12
dojo#294 Feedback 13
dojo#293 Feedback 1
dojo#293 Feedback 2
dojo#293 Feedback 14
dojo#293 Feedback 15
dojo#291 Feedback 1
dojo#291 Feedback 2
dojo#291 Feedback 3
dojo#291 Feedback 5
dojo#291 Feedback 6
dojo#291 Feedback 8
dojo#291 Feedback 16
dojo#289 Feedback 6

Resolves dojo#273
Resolves dojo#274
Resolves dojo#282
Resolves dojo#283
Resolves dojo#284
Resolves dojo#286
Resolves dojo#287
Resolves dojo#242
Resolves dojo#241
Resolves dojo#239
Resolves dojo#238
Resolves dojo#234
Resolves dojo#232
Resolves dojo#231
Resolves dojo#227
Resolves dojo#271
Resolves dojo#268
umaar added a commit that referenced this issue Oct 23, 2017
* #245 Feedback 1
#244 Feedback 1
#270 Feedback 1
#258 Feedback 1
#251 Feedback 3
#251 Feedback 4
#250 Feedback 2
#295 Feedback 1
#295 Feedback 5
#294 Feedback 3
#294 Feedback 9
#294 Feedback 12
#294 Feedback 13
#293 Feedback 1
#293 Feedback 2
#293 Feedback 14
#293 Feedback 15
#291 Feedback 1
#291 Feedback 2
#291 Feedback 3
#291 Feedback 5
#291 Feedback 6
#291 Feedback 8
#291 Feedback 16
#289 Feedback 6

Resolves #273
Resolves #274
Resolves #282
Resolves #283
Resolves #284
Resolves #286
Resolves #287
Resolves #242
Resolves #241
Resolves #239
Resolves #238
Resolves #234
Resolves #232
Resolves #231
Resolves #227
Resolves #271
Resolves #268

* Fix instruction text in tutorial
edhager pushed a commit to edhager/dojo.io that referenced this issue Oct 26, 2017
* dojo#245 Feedback 1
dojo#244 Feedback 1
dojo#270 Feedback 1
dojo#258 Feedback 1
dojo#251 Feedback 3
dojo#251 Feedback 4
dojo#250 Feedback 2
dojo#295 Feedback 1
dojo#295 Feedback 5
dojo#294 Feedback 3
dojo#294 Feedback 9
dojo#294 Feedback 12
dojo#294 Feedback 13
dojo#293 Feedback 1
dojo#293 Feedback 2
dojo#293 Feedback 14
dojo#293 Feedback 15
dojo#291 Feedback 1
dojo#291 Feedback 2
dojo#291 Feedback 3
dojo#291 Feedback 5
dojo#291 Feedback 6
dojo#291 Feedback 8
dojo#291 Feedback 16
dojo#289 Feedback 6

Resolves dojo#273
Resolves dojo#274
Resolves dojo#282
Resolves dojo#283
Resolves dojo#284
Resolves dojo#286
Resolves dojo#287
Resolves dojo#242
Resolves dojo#241
Resolves dojo#239
Resolves dojo#238
Resolves dojo#234
Resolves dojo#232
Resolves dojo#231
Resolves dojo#227
Resolves dojo#271
Resolves dojo#268

* Fix instruction text in tutorial
edhager pushed a commit to edhager/dojo.io that referenced this issue Oct 26, 2017
* dojo#245 Feedback 1
dojo#244 Feedback 1
dojo#270 Feedback 1
dojo#258 Feedback 1
dojo#251 Feedback 3
dojo#251 Feedback 4
dojo#250 Feedback 2
dojo#295 Feedback 1
dojo#295 Feedback 5
dojo#294 Feedback 3
dojo#294 Feedback 9
dojo#294 Feedback 12
dojo#294 Feedback 13
dojo#293 Feedback 1
dojo#293 Feedback 2
dojo#293 Feedback 14
dojo#293 Feedback 15
dojo#291 Feedback 1
dojo#291 Feedback 2
dojo#291 Feedback 3
dojo#291 Feedback 5
dojo#291 Feedback 6
dojo#291 Feedback 8
dojo#291 Feedback 16
dojo#289 Feedback 6

Resolves dojo#273
Resolves dojo#274
Resolves dojo#282
Resolves dojo#283
Resolves dojo#284
Resolves dojo#286
Resolves dojo#287
Resolves dojo#242
Resolves dojo#241
Resolves dojo#239
Resolves dojo#238
Resolves dojo#234
Resolves dojo#232
Resolves dojo#231
Resolves dojo#227
Resolves dojo#271
Resolves dojo#268

* Fix instruction text in tutorial
@dylans dylans added this to the 2017.11 milestone Oct 27, 2017
@kitsonk kitsonk modified the milestones: 2017.11, 2017.12 Dec 1, 2017
@dylans dylans removed this from the 2017.12 milestone Jan 17, 2018
@dylans dylans added this to the 2.0.0 milestone Mar 10, 2018
@dylans dylans removed this from the 2.0.0 milestone Apr 24, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants