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

Documentation for customizing admin forms is out-of-date / unclear #1396

Open
matthewhegarty opened this issue Feb 18, 2022 · 4 comments
Open
Labels
docs good first issue An issue for a first time contributor

Comments

@matthewhegarty
Copy link
Contributor

The documentation describes how to customize the import forms. The example shows how you can add an author field, but it doesn't make it clear what the purpose of this is, and that you have to provide any filtering capabilities yourself. This has led to some confusion.

I propose to update this section so that it is clearer why you would want to customize the import forms, and to give an example of how to filter using a dropdown.

@matthewhegarty matthewhegarty added docs good first issue An issue for a first time contributor labels Feb 18, 2022
@eldavo
Copy link

eldavo commented Sep 12, 2023

Thanks Matthew for the help on StackOverflow. I expect the issue I encountered as a new user of django-import-export is not uncommon and it would be great to make the docs around this more specific. https://stackoverflow.com/questions/77085694/django-import-export-customize-admin-missing-field-error

@matthewhegarty
Copy link
Contributor Author

Hi Dave, yes I agree that the docs could be improved. If you felt like sharing your experiences and submitting a PR, I'd be happy to review.

@Murgowt
Copy link

Murgowt commented Jan 20, 2024

Hello @matthewhegarty, Could you please assign this issue to me, I would love the opportunity to work on this issue.

@matthewhegarty
Copy link
Contributor Author

Hi - thanks for the offer of help. Please use the release-4 branch as this has the most recent changes. I strongly recommend posting your proposal for changes here before starting on any work, just so we can be sure it fits.

Please read this comment. It is an improvement to the documentation which demonstrates how the selected 'author' field can be saved to the db.

Another area that might be of interest is to post tutorials on dev.to demonstrating how to use and customise the example app. If these are useful, we can link from the github README page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs good first issue An issue for a first time contributor
Projects
None yet
Development

No branches or pull requests

3 participants