Opened 7 years ago

Closed 6 years ago

Last modified 4 years ago

#9454 closed (fixed)

Typos and suggestions regarding the porting howto

Reported by: egenix_viktor Owned by: jacob
Component: Documentation Version: 1.0
Severity: Keywords:
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: yes
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

There is a very useful documentation page describing how to quickly port 0.96 application to 1.0. I found the following problems while porting a real world application:

  • No information on how to update manage.py in your projects.
  • The following section should be moved up, since one might complete the translation by hand before even encounter the comment below:

"See also

A contributor to djangosnippets has written a script that'll scan your models.py and generate a corresponding admin.py."

  • Typos:

"the framework as been rewritten" => "the framework has been rewritten"

Change History (7)

comment:1 Changed 7 years ago by egenix_viktor

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

The porting HOWTO does not mention that the js attribute won't work any more for the Admin classes, but they should be moved into the new nested class Media. It is mentioned in the newforms documentation, however. It affects the application only if it has any custom scripts for the admin interface, like the ones required to integrate FCKEditor or TinyMCE for easy HTML authoring.

Instead of:

class ContentAdmin(admin.ModelAdmin):
    ...
    js = ('/media/fckeditor/fckeditor.js',
          '/media/js/admin_content.js')

You have to write:

class ContentAdmin(admin.ModelAdmin):
    ...
    class Media:
        js = ('/media/fckeditor/fckeditor.js',
              '/media/js/admin_content.js')

So you have such a nested class structure as before.

comment:2 Changed 7 years ago by egenix_viktor

  • Needs documentation set

comment:3 Changed 7 years ago by mtredinnick

No changes to manage.py are required in normal porting, so that's a moot point. For the rest, please create a patch to make it easier to apply this.

comment:4 Changed 6 years ago by jacob

  • milestone set to 1.1
  • Triage Stage changed from Unreviewed to Accepted

comment:5 Changed 6 years ago by jacob

  • Owner changed from nobody to jacob
  • Status changed from new to assigned

comment:6 Changed 6 years ago by jacob

  • Resolution set to fixed
  • Status changed from assigned to closed

(In [10371]) Fixed a whole bunch of small docs typos, errors, and ommissions.

Fixes #8358, #8396, #8724, #9043, #9128, #9247, #9267, #9267, #9375, #9409, #9414, #9416, #9446, #9454, #9464, #9503, #9518, #9533, #9657, #9658, #9683, #9733, #9771, #9835, #9836, #9837, #9897, #9906, #9912, #9945, #9986, #9992, #10055, #10084, #10091, #10145, #10245, #10257, #10309, #10358, #10359, #10424, #10426, #10508, #10531, #10551, #10635, #10637, #10656, #10658, #10690, #10699, #19528.

Thanks to all the respective authors of those tickets.

comment:18 Changed 4 years ago by jacob

  • milestone 1.1 deleted

Milestone 1.1 deleted

Note: See TracTickets for help on using tickets.
Back to Top