Opened 10 years ago

Closed 8 years ago

Last modified 6 years ago

#5096 closed (fixed)

Doc: Model ref mentions sql-based initial data, should use fixtures

Reported by: oggie rob <oz.robharvey@…> Owned by: Jacob
Component: Documentation Version: master
Severity: Keywords: sprint-pycon08
Cc: ctrochalakis Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

In 0.96 release notes, there is a mention that fixtures should be used for initial data and custom sql for view, procedures, etc. However the model reference docs show an example using custom sql files and don't mention fixtures at all. For consistency the models ref should describe fixtures and distinguish between the use of fixtures & custom sql files.

Attachments (1)

fixtures-documentation.diff (20.7 KB) - added by Remco Wendt 9 years ago.
First concept of fixtures documentation

Download all attachments as: .zip

Change History (23)

comment:1 Changed 10 years ago by anonymous

Owner: changed from nobody to anonymous
Status: newassigned

Agree.

comment:2 Changed 10 years ago by Simon G <dev@…>

Needs documentation: set
Triage Stage: UnreviewedAccepted

Please don't do anonymous triage.

comment:3 Changed 9 years ago by Remco Wendt

Keywords: sprint-pycon08 added
Owner: changed from anonymous to Remco Wendt
Status: assignednew

comment:4 Changed 9 years ago by Remco Wendt

Status: newassigned

comment:5 Changed 9 years ago by Remco Wendt

Information about fixtures is dispersed between different parts of the documentation, I'm actually thinking of giving the concept of fixtures its own entry in the references list. Going to talk this over with Adrian.

comment:6 Changed 9 years ago by Remco Wendt

Adrian agrees with this, working on it now.

comment:7 Changed 9 years ago by Remco Wendt

Has patch: set

Ok first concept of the fixtures documentation is ready, adding patch.

Changed 9 years ago by Remco Wendt

Attachment: fixtures-documentation.diff added

First concept of fixtures documentation

comment:8 Changed 9 years ago by ctrochalakis

Cc: ctrochalakis added

comment:9 Changed 9 years ago by Jacob

Owner: changed from Remco Wendt to Jacob
Status: assignednew

comment:10 Changed 9 years ago by Jacob

Triage Stage: AcceptedReady for checkin

Looks nice - I'll proofread and check in.

comment:11 Changed 9 years ago by Marc Fargas

Needs documentation: unset

comment:12 Changed 9 years ago by Jacob

milestone: 1.0

comment:13 Changed 9 years ago by Russell Keith-Magee

Resolution: fixed
Status: newclosed

It looks to me like these changes have been incorporated (or added independently) into the new docs. If there is something missing, please provide an updated diff against the new docs.

comment:14 Changed 9 years ago by Jacob

Resolution: fixed
Status: closedreopened

Sorry, I'm actually still working on this one.

comment:15 Changed 9 years ago by Jacob

Status: reopenednew
Triage Stage: Ready for checkinAccepted

comment:16 Changed 9 years ago by Jacob

Status: newassigned

comment:17 Changed 9 years ago by Jacob

milestone: 1.0post-1.0

I'm nearly done with this, but I'm not going to have it done for the official 1.0 release. Sorry!

comment:18 Changed 8 years ago by (none)

milestone: post-1.0

Milestone post-1.0 deleted

comment:19 Changed 8 years ago by Russell Keith-Magee

milestone: 1.1

comment:20 Changed 8 years ago by Malcolm Tredinnick

Jacob, do you have a partial rewrite of this in a local branch, or should I just take this patch and munge it appropriately? I don't want to duplicate work if you're partially there.

comment:21 Changed 8 years ago by Malcolm Tredinnick

Resolution: fixed
Status: assignedclosed

The docs/howto/initial-data.txt file appears to contain a fairly clear discussion of the two options here. Closing this, since it looks fairly complete. If somebody wants to do something else, open a new ticket with a clear patch against trunk that we can evaluate, but I think the proposed changes have all been merged in now.

comment:22 Changed 6 years ago by Jacob

milestone: 1.1

Milestone 1.1 deleted

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