Opened 8 years ago

Last modified 3 years ago

#14596 assigned defect

Reference guide updates to use AMD loader

Reported by: Maastermedia Owned by: Kitson Kelly
Priority: high Milestone: 1.15
Component: Documentation Version: 1.7.1
Keywords: Cc: peter.kokot@…
Blocked By: Blocking:

Description

Hello,

reference guide is still mainly written for old Dojo loader. Are there any plans for updating documentation according to the new AMD loader?

One simple example where is only < 1.7 example: http://livedocs.dojotoolkit.org/dijit/form/Button#programmatic-example

Or for instance this example has both examples. For 1.7 and < 1.7: http://livedocs.dojotoolkit.org/dojo/parser#loading-the-parser

I have CLA and would be happy to help you change the docs. I just need some info from developers what is the plan with current reference guide and what can be done to improve docs for new users and not to dissapoint old users with new examples.

Change History (16)

comment:1 Changed 8 years ago by Maastermedia

I also see 1.7 branch on github which is great and exactly what is needed. So how to contribute? Sorry for using this ticket. I don't have the devs mailing list account approved yet.

comment:2 Changed 8 years ago by bill

Hi @mastermedia - thanks for volunteering, that's great! We'll definitely take pull requests. For some of the simpler dojo examples we have both pre and post 1.7 examples but for the bigger things, and for all the dijit pages, I just want to have the AMD format examples.

See http://oksoclap.com/22eEx9Hh4Q for some information on being able to test your changes.

As for the branches, until now we've been putting changes into trunk and until a few weeks ago I was cherry-picking some of them into the 1.7 branch. But at this point I'm not sure which trunk changes are suitable for the 1.7 and which refer to 1.8-only functionality, so I guess we should abandon the 1.7 branch and just concentrate on the trunk.

comment:3 Changed 8 years ago by Maastermedia

Ok. Yes, please leave the 1.7 branch somewhere for users who would like to see old examples for 1.6 and older dojo versions. Will get to it and send pull requests to take in your consideration of merging in the master (trunk).

Thank you.

comment:4 Changed 8 years ago by bill

Sure, that's the plan. The 1.6 data is still around too: http://dojotoolkit.org/reference-guide/1.6/, just unfortunately not linked from the main website page yet.

Last edited 8 years ago by bill (previous) (diff)

comment:5 Changed 8 years ago by bill

PS: be sure to pull often, so you are working on the latest doc. For example I just checked in a bunch of changes for the new data-dojo-type="module/id" syntax.

comment:6 Changed 8 years ago by Maastermedia

Ok, will do. No problem. I try to use github at its best. Btw. best system for working with github directly:

  • fork a dojo/docs repo
  • git clone git@…:yourusername/docs
  • git remote add upstream git://github.com/dojo/docs
  • git config branch.master.remote upstream
  • git checkout -b your-branch
  • git add .
  • git commit -m "typo in dijit/Button"
  • git push origin your-branch
  • open pull request on your github account and send your-branch to upstream's master

If the upstream dojo/docs have changed then you will have to do some mergin in your-branch:

  • git checkout master
  • git pull --rebase
  • git checkout your-branch
  • git merge ...

comment:7 Changed 8 years ago by bill

Summary: Reference guide needs updatesReference guide updates to use AMD loader

comment:8 Changed 7 years ago by bill

Milestone: tbd1.8
Owner: set to Kitson Kelly
Status: newassigned

Kitson, you said you were finishing this task IIRC. (We all appreciate it.)

After you get it done we can update rstWiki to set djConfig to async: true by default.

comment:9 Changed 7 years ago by Maastermedia

Ok, great. I will work on it also...

Last edited 7 years ago by Maastermedia (previous) (diff)

comment:10 Changed 7 years ago by Kitson Kelly

Milestone: 1.81.8.1

Work on this continues, significant process has been made, but won't be 100% for 1.8.0, migration to next milestone.

comment:11 Changed 7 years ago by Kitson Kelly

Milestone: 1.8.11.8.2

comment:12 Changed 7 years ago by Kitson Kelly

Milestone: 1.8.21.9

comment:13 Changed 6 years ago by Colin Snover

Milestone: 1.91.10

1.9 is released; moving remaining tickets to next milestone.

comment:14 Changed 5 years ago by dylan

Milestone: 1.101.11

comment:15 Changed 4 years ago by dylan

Milestone: 1.111.12

Much of the reference guide is up to date, but keeping this meta ticket open for the next release.

comment:16 Changed 3 years ago by dylan

Milestone: 1.131.15

Ticket planning... move current 1.13 tickets out to 1.15 to make it easier to move tickets into the 1.13 milestone.

Note: See TracTickets for help on using tickets.