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

[Feature] Add a guides folder #237

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

egbadon-victor
Copy link
Contributor

Fixes

Description

This PR creates a guides folder with a setup_instructions guide.

Technical details

Implementation is completely straightforward, as it only involves following guidelines to add guides.

Tests

  • I ensured I followed guidelines outlined in the guides/README.md file of the creativecommons/search repo.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    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
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@egbadon-victor egbadon-victor requested review from a team as code owners October 17, 2024 10:11
@egbadon-victor egbadon-victor requested review from TimidRobot, Shafiya-Heena and krysal and removed request for a team October 17, 2024 10:11
@egbadon-victor
Copy link
Contributor Author

@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/README.md Outdated Show resolved Hide resolved
guides/setup_instructions.md Outdated Show resolved Hide resolved
Comment on lines 41 to 49
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=
Copy link
Member

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

Copy link
Member

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.

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.
Copy link
Member

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


> **Note**: While the terminal may display `http://0.0.0.0:8000`, use `127.0.0.1:8000` in your browser.

## Troubleshooting
Copy link
Member

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

guides/README.md Show resolved Hide resolved
@egbadon-victor
Copy link
Contributor Author

@TimidRobot all changes noted.

What I can gather from this is that this PR should only contain changes to the README.md file in the guides folder, as the contents of the setup_instructions.md can be implemented as comments in the .env.template file and additions to the README.md file.

I would be making seperate PRs for the changes to the README.md file and .env.template file, as these are related to already open issues in the repository(#200 ). I would be referencing these comments for visibility.

@egbadon-victor
Copy link
Contributor Author

@TimidRobot , #249 covers a lot of the corrections made in the implementation of the setup_instructions.md file. I have dropped a comment under the PR , linking the corrections made here so that @FatumaA could include them to her work. This is to avoid duplication of efforts.

@egbadon-victor egbadon-victor changed the title [Feature] Adds setup guide to guides folder [Feature] Add a guides folder Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In review
Development

Successfully merging this pull request may close these issues.

[Feature] Addition of a guides folder for beginner to this project
2 participants