RFC 44: Make "Custom models" the default #44

kaedroho · 2019-10-23T20:57:18Z

Rendered

text/044-image-models.md

chosak · 2019-10-23T21:34:13Z

text/044-image-models.md

+
+### Remove the “Custom image model” advanced topics doc
+
+We could replace this with a reference document that describes the methods that developers can override to tweak its behaviour.


Something similar would need to be done for the Custom document model documentation page.

lb- · 2019-10-27T06:00:45Z

Hey, finally got the chance to read this and 100% agree that this would be helpful and enable a lot of future improvements over time.

I have also put up an issue on the main repo to add some fields to the image/document models that would be really useful wagtail/wagtail#5658.

Finally, I did some analysis of about 78 different document/image models I found on Github projects. This will give a bit of an indicator of the kinds of changes made by developers.

https://docs.google.com/spreadsheets/d/1JgrDb5s_ugAnL04r3GOBqh5DodZodqqp3rqrN1sTKpE/edit?usp=sharing

The top ten fields added in custom models are:

16 x caption probably because it is in the docs
12 x credit
11 x alt / alt_text yes, I know we are not adding this and I agree but just FYI
9 x description / details / summary
7 x author
7 x source / source_name
5 x source_url / external_url
4 x attribution
4 x file
4 x licence / license
3 x copyright_year / year

kaedroho · 2019-10-29T12:30:17Z

We discussed this as a croe team meeting so I think this is at least stage 2

Co-Authored-By: Andy Chosak <[email protected]>

thibaudcolas

Ref wagtail/wagtail#5789 – I’d love to see this happen. There are a few things here I’d like to see changed but they feel pretty minor. In particular more consideration on the app name, whether a rename of the existing models is worthwhile, and consideration to include a custom User model as well.

thibaudcolas · 2023-10-06T21:57:04Z

text/044-image-models.md

+custom image model from the start. This change will add a small amount
+of extra code to the project template, which I know we would want to
+avoid, but I think preventing a potentially arduous migration later
+outweighs the overhead of having one extra app in the project.


thibaudcolas · 2023-10-06T21:57:48Z

text/044-image-models.md

+avoid, but I think preventing a potentially arduous migration later
+outweighs the overhead of having one extra app in the project.
+
+This change also applies to image rendition and document models as well.


I think this would warrant reflecting in the RFC title.

thibaudcolas · 2023-10-06T21:58:42Z

text/044-image-models.md

+
+### Update the project template to use custom image, rendition, and document models
+
+We will add a new app called `assets` into the base project template.


I would like to see alternative proposals for what this app should be called, ideally backed with data on what app name real-world projects put those models in.

we used media (and added custom wagtailmedia classes there as well)

thibaudcolas · 2023-10-06T22:02:50Z

text/044-image-models.md

+### Remove the "Custom image model" advanced topics doc
+
+We could replace this with a reference document that describes the
+methods that developers can override to tweak its behaviour.


Here and below – I’m not sure I follow. I’d still call it a custom image model as it’s custom to each project. And the docs would still be useful for the thousands of project that have been existing before the changes suggested here. And the projects that get created without wagtail start?

My proposal here was to remove the option of not having a custom user model as much as possible, so everyone going forward would create one. This is one of the many things new users need to know about when building their first Wagtail project and I wanted to remove this as an option to reduce decision fatigue.

For existing users, we could provide a how-to-guide for "upgrading" to the new favoured approach (while making it clear the old way won't be removed) rather than an "advanced topics" document that implies it's an optional "advanced" feature.

I missed out projects that get created without wagtail start in this doc, perhaps we should add these models to the "adding to an existing django project" doc as well.

thibaudcolas · 2023-10-06T22:03:55Z

text/044-image-models.md

+We will add the `assets` app as described in the previous section and
+update the fixtures and foreign keys to use this new app.
+
+### Rename the built-in models to fix naming conflict and discourage their use


I’m not clear on whether the effort suggested here is justified? This feels like a lot of potential busywork.

thibaudcolas · 2023-10-06T22:07:50Z

text/044-image-models.md

+
+To implement this RFC, we will make the following changes:
+
+### Update the project template to use custom image, rendition, and document models


Could we also add a custom User model, based on the same rationale?

rgs258 · 2024-04-18T00:21:01Z

Any chance of a custom Page model :)

thibaudcolas · 2024-05-17T12:27:47Z

@rgs258 😄 can you say more?

NotANormalNerd · 2024-05-19T16:43:02Z

@thibaudcolas I can elavorate. It would be amazing to have a Swappable Page model, like the user model, so we can add custom fields and other stuff to the base page. Right now we have to fork wagtail and add changes to the base page there.
We can't add a "additonal" model via foreign key for performance and other reasons.

So to have the a custom page model by default, that can inherit from a "AbstractBasePage" would be amazing. Wagtail could work with the AbstractBasePage and people could add whatever they need to their Page Model.

Stormheg · 2024-06-12T09:58:20Z

We briefly discussed this RFC again during the core team meeting today. This RFC needs answers to the remaining comments by Thibaud and we can move this to final comment period after. Keen to see this become the default 👍

@kaedroho would you be okay with me taking over this RFC? Or would you rather implement it yourself.

kaedroho added 2 commits October 23, 2019 21:57

Make "Custom image model" the default

441be38

Number 44

5299449

kaedroho added the 1:New label Oct 23, 2019

kaedroho changed the title ~~Make "Custom image model" the default~~ RFC 44: Make "Custom image model" the default Oct 23, 2019

chosak reviewed Oct 23, 2019

View reviewed changes

lb- mentioned this pull request Oct 27, 2019

Add additional fields to image & document models wagtail/wagtail#5658

Open

kaedroho added 2:Accepted and removed 1:New labels Oct 29, 2019

kaedroho and others added 7 commits October 30, 2019 15:31

Update text/044-image-models.md

9df856f

Co-Authored-By: Andy Chosak <[email protected]>

Update text/044-image-models.md

ec46dfa

Co-Authored-By: Andy Chosak <[email protected]>

Update text/044-image-models.md

a52cc07

Co-Authored-By: Andy Chosak <[email protected]>

Update text/044-image-models.md

9e5ce46

Co-Authored-By: Andy Chosak <[email protected]>

Update text/044-image-models.md

9e0b82d

Co-Authored-By: Andy Chosak <[email protected]>

Wording tweaks

5843785

Tweaks

5655986

emilytoppm mentioned this pull request Jan 24, 2020

Default custom image & document model wagtail/wagtail#5789

Closed

nmorduch added the Proposed label Oct 12, 2020

thibaudcolas added 3:Review and removed 2:Accepted Proposed labels Oct 6, 2023

thibaudcolas requested changes Oct 6, 2023

View reviewed changes

thibaudcolas self-assigned this Oct 6, 2023

thibaudcolas changed the title ~~RFC 44: Make "Custom image model" the default~~ RFC 44: Make "Custom models" the default Oct 20, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RFC 44: Make "Custom models" the default #44

RFC 44: Make "Custom models" the default #44

kaedroho commented Oct 23, 2019 •

edited

Loading

chosak Oct 23, 2019

lb- commented Oct 27, 2019

kaedroho commented Oct 29, 2019

thibaudcolas left a comment

thibaudcolas Oct 6, 2023

thibaudcolas Oct 6, 2023

thibaudcolas Oct 6, 2023

zerolab Jun 13, 2024

thibaudcolas Oct 6, 2023

kaedroho May 24, 2024 •

edited

Loading

thibaudcolas Oct 6, 2023 •

edited

Loading

thibaudcolas Oct 6, 2023

rgs258 commented Apr 18, 2024

thibaudcolas commented May 17, 2024

NotANormalNerd commented May 19, 2024

Stormheg commented Jun 12, 2024


		### Remove the “Custom image model” advanced topics doc

		We could replace this with a reference document that describes the methods that developers can override to tweak its behaviour.


		### Update the project template to use custom image, rendition, and document models

		We will add a new app called `assets` into the base project template.


		To implement this RFC, we will make the following changes:

		### Update the project template to use custom image, rendition, and document models

RFC 44: Make "Custom models" the default #44

Are you sure you want to change the base?

RFC 44: Make "Custom models" the default #44

Conversation

kaedroho commented Oct 23, 2019 • edited Loading

chosak Oct 23, 2019

Choose a reason for hiding this comment

lb- commented Oct 27, 2019

kaedroho commented Oct 29, 2019

thibaudcolas left a comment

Choose a reason for hiding this comment

thibaudcolas Oct 6, 2023

Choose a reason for hiding this comment

thibaudcolas Oct 6, 2023

Choose a reason for hiding this comment

thibaudcolas Oct 6, 2023

Choose a reason for hiding this comment

zerolab Jun 13, 2024

Choose a reason for hiding this comment

thibaudcolas Oct 6, 2023

Choose a reason for hiding this comment

kaedroho May 24, 2024 • edited Loading

Choose a reason for hiding this comment

thibaudcolas Oct 6, 2023 • edited Loading

Choose a reason for hiding this comment

thibaudcolas Oct 6, 2023

Choose a reason for hiding this comment

rgs258 commented Apr 18, 2024

thibaudcolas commented May 17, 2024

NotANormalNerd commented May 19, 2024

Stormheg commented Jun 12, 2024

kaedroho commented Oct 23, 2019 •

edited

Loading

kaedroho May 24, 2024 •

edited

Loading

thibaudcolas Oct 6, 2023 •

edited

Loading