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

added whitenoise, updated readme #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ihelmer07
Copy link

Added more direction for ReadMe.
Added WhiteNoise so one can demo a production environment (Debug=False)

@ihelmer07
Copy link
Author

ihelmer07 commented Dec 9, 2021

I don't understand why you want to put this inside the doc. It's a thing you maybe have to do in your environment.
I think it may be useful for a minority of people and for beginner it will be confusing.
Personnaly I serve static files with Nginx and the default Django static files system in production and well configured it works like a charm.
What do you think of maybe, put your doc inside another .md file not inside the root one, and juste put a simple
link to it in the root one ?
(We can continue this conversion in your PR if you want).

Responding to your comments on my issue.

I chose WhiteNoise because its a standalone static file server and is self-contained to the project.

This allows someone on the new-ish side of frontend web development & vite to simply clone your repo, follow the instructions I added and have a working Proof of Concept for both Development and Production all within one folder.

Then they could extrapolate that to their set up with thier set up (apache, nginx, etc.)

If you don't want it in the master branch and root ReadMe that would be fine - you could have a WhiteNoise branch and point it out that if they want to see a working production version they could look there.

Or the root ReadMe could remove notes of whitenoise but still have the set up portions of what I added to guide them a bit better on what they need to do in order to get it working.

Up to you, just trying to stop future users from running into the stupid mistakes I did.

@MrBin99
Copy link
Owner

MrBin99 commented Dec 13, 2021

Ok I understand better thanks.

No I don't want a new branch. But I think it will be better to add a docs/whitenoise.md file.
And add just a link in the root README under a title like "To go further" and bullet points with lot of specific stuff
that you're right could be useful for some people.
So in the future people who wants to add more docs on others libraries can do the same thing and we keep all stuff organized.

What do you think ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants