When generating projects without some of the optional settings (e.g. no database settings), some of the cookie cutter template docs can be a bit misleading:
Example (from docs/dev/settings.md):
Setting Values
Configure the application using environment variables:
# Set environment variables
export PROJECT_NAME="My Application"
export DEBUG="True"
export DATABASE_URL="postgresql+asyncpg://user:pass@localhost/mydb"
# Or use a .env file
echo 'PROJECT_NAME="My Application"' > .env
echo 'DEBUG=True' >> .env
echo 'DATABASE_URL="postgresql+asyncpg://user:pass@localhost/mydb"' >> .env
In a case where the project doesn't actually interface with a DB, some example environment variables that are more generic like MY_SETTING="foobar" might be more appropriate.
I don't think conditional rendering for all documentation is required, but a quick disclaimer in the README.md or in the cookiecutter template output might help clarity.
When generating projects without some of the optional settings (e.g. no database settings), some of the cookie cutter template docs can be a bit misleading:
Example (from
docs/dev/settings.md):In a case where the project doesn't actually interface with a DB, some example environment variables that are more generic like MY_SETTING="foobar" might be more appropriate.
I don't think conditional rendering for all documentation is required, but a quick disclaimer in the README.md or in the cookiecutter template output might help clarity.