-
Notifications
You must be signed in to change notification settings - Fork 68
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
[Feature] Add a guides folder #237
base: main
Are you sure you want to change the base?
Conversation
@TimidRobot here is an example of a guide. subsequent guides will be implemented as seperate PRs, indicating what specific guide is being implemented, while still linking it to the #210 issue. |
guides/setup_instructions.md
Outdated
DJANGO_SECRET_KEY="your_random_string" | ||
DJANGO_DEBUG_ENABLED=True | ||
DJANGO_DATABASE_PASSWORD=postgres # or your chosen password | ||
DJANGO_SUPERUSER_PASSWORD="your_chosen_password" | ||
DJANGO_TIME_ZONE="UTC" | ||
DJANGO_SECURE_SSL_REDIRECT=False | ||
DJANGO_COMPRESS_ENABLED=True | ||
DJANGO_COMPRESS_OFFLINE=True | ||
LIBSASS_OUTPUT_STYLE= |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The .env.template
could be updated with comments to indicate which variables must be updated/populated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Additionally, sentence could be added to the repository README. Something like:
See the comments in your newly copied .env
for which variables must be set.
guides/setup_instructions.md
Outdated
http://127.0.0.1:8000 | ||
``` | ||
|
||
> **Note**: While the terminal may display `http://0.0.0.0:8000`, use `127.0.0.1:8000` in your browser. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a great note to add to the Start (and Build) the Servers section of the repository README
guides/setup_instructions.md
Outdated
|
||
> **Note**: While the terminal may display `http://0.0.0.0:8000`, use `127.0.0.1:8000` in your browser. | ||
|
||
## Troubleshooting |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think Troubleshooting should be its own guide
@TimidRobot all changes noted. What I can gather from this is that this PR should only contain changes to the I would be making seperate PRs for the changes to the |
@TimidRobot , #249 covers a lot of the corrections made in the implementation of the |
Fixes
Description
This PR creates a
guides
folder with asetup_instructions
guide.Technical details
Implementation is completely straightforward, as it only involves following guidelines to add guides.
Tests
creativecommons/search
repo.Checklist
Update index.md
).main
ormaster
).visible errors.
Developer Certificate of Origin
For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."
Developer Certificate of Origin