better docs - Githubissues

jerimiah-smiggins / smiggins

a social media platform that i made so that means its cool

https://trinkey.pythonanywhere.com

GNU General Public License v3.0

8 stars 6 forks source link

better docs #265

Open trinkey opened 3 days ago

trinkey commented 3 days ago

add docs for

[x] createsuperuser
[x] upgrading instance w scripts
[x] configuring CSRF_TRUSTED_ORIGINS (also make it set to website_url from settings if available)
[ ] nginx reverse proxy
[ ] settting up gunicorn
[ ] settting up docker
[x] user id vs username
[x] how to set up emails
etc

trinkey commented 3 days ago

@Subroutine7901 @4kh00 do either of you have any other things that you think I should document?

Subroutine7901 commented 3 days ago

Basic nginx setup and setup for production on not-pythonanywhere is a good one Also all the backend settings and/or api? I guess swagger does the last one though

4kh00 commented 2 days ago

FAQ, like "What is the user ID?" or things like "Do you have X feature?" with the answer being "Make an issue!"

trinkey commented 4 hours ago

Also all the backend settings...

I feel this isn't needed as they all have comments in the settings file already