[Feature] Add a guides folder

egbadon-victor commented 1 month ago

Fixes

Fixes #210 by @egbadon-victor

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

[x] My pull request has a descriptive title (not a vague title like Update index.md).
[x] My pull request targets the default branch of the repository (main or master).
[x] My commit messages follow best practices.
[x] My code follows the established code style of the repository.
[ ] I added or updated tests for the changes I made (if applicable).
[x] I added or updated documentation (if applicable).
[x] 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 commented 1 month ago

@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.

egbadon-victor commented 1 month ago

@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 commented 1 month ago

@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 commented 2 weeks ago

Thank you!

creativecommons / legaldb