search

keyshade-xyz / keyshade

Realtime secret and configuration management tool, with the best in class security and seamless integration support
https://keyshade.xyz
Mozilla Public License 2.0
208 stars 105 forks source link

docs: Added docker details in setting-things-up.md #358

Closed rajdip-b closed 4 months ago

rajdip-b commented 4 months ago

PR Type

Documentation

Description

Changes walkthrough 📝

Relevant files
Documentation
running-the-api.md
Remove Docker Compose instructions for API setup                 
docs/contributing-to-keyshade/running-things-locally/running-the-api.md
  • Removed instructions to start database and cache using Docker Compose.

    		•  +0/-6     
    setting-things-up.md
    Add Docker Compose setup instructions for development environment
    docs/contributing-to-keyshade/setting-things-up.md
  • Added detailed instructions for setting up the development environment
    using Docker Compose.
  • Included information about required ports and troubleshooting
    PostgreSQL issues.
  • Added instructions for shutting down the Docker infrastructure.
    		•  +37/-0   

    💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    codiumai-pr-agent-free[bot] commented 4 months ago

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No key issues to review
    codiumai-pr-agent-free[bot] commented 4 months ago

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Enhancement
    ✅ Correct the typo in the section title ___
    Suggestion Impact:The typo in the section title was corrected as suggested. code diff: ```diff -## Settng up the development environment +## Setting up the development environment ```
    ___ **There's a typo in the section title "Settng up the development environment". It
    should be corrected to "Setting up the development environment" to maintain
    professionalism and clarity in documentation.** [docs/contributing-to-keyshade/setting-things-up.md [64]](https://github.com/keyshade-xyz/keyshade/pull/358/files#diff-cef348a8823f15a58b87562625cba74999f427c52980164863ee234f45897d44R64-R64) ```diff -## Settng up the development environment +## Setting up the development environment ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 9 Why: The suggestion addresses a clear typo in a section title, which is important for maintaining professionalism and clarity in the documentation.
    		9
    Correct typos and clarify the description of service exposure ___ **The phrase "then expose the services yo your host maching" contains a typo and is
    somewhat unclear. It would be clearer to say "then expose the services to your host
    machine".** [docs/contributing-to-keyshade/setting-things-up.md [72]](https://github.com/keyshade-xyz/keyshade/pull/358/files#diff-cef348a8823f15a58b87562625cba74999f427c52980164863ee234f45897d44R72-R72) ```diff -This will start the following things in a dockerized environment and then expose the services yo your host maching: +This will start the following things in a dockerized environment and then expose the services to your host machine: ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 9 Why: The suggestion fixes typos and improves the clarity of the documentation, which enhances readability and comprehension for users.
    		9
    Possible issue
    Restore or update the Docker setup instructions for the database and cache ___ **It appears that the instructions for starting the database and cache using Docker
    were removed. If these steps are still necessary for setting up the environment,
    consider adding them back or providing updated instructions if the setup process has
    changed.** [docs/contributing-to-keyshade/running-things-locally/running-the-api.md [6-11]](https://github.com/keyshade-xyz/keyshade/pull/358/files#diff-4b84bcb62b13e2e4f44c579cd7dd35f74955f2bc7e66c573ce2e4b9517c8f9eaR6-R11) ```diff -- Get the database and cache up and running: +- Start the necessary Docker containers for the database and cache: ```bash docker compose up -d ``` ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 8 Why: The suggestion correctly identifies the removal of important setup instructions for the database and cache. Restoring or updating these instructions is crucial for users to set up their development environment properly.
    		8
    Maintainability
    Improve the readability of the port requirements by using a bulleted list with descriptions ___ **To enhance the clarity and readability of the documentation, consider using a
    bulleted list for the ports that need to be free. This format can make it easier for
    users to quickly scan through the required information.** [docs/contributing-to-keyshade/setting-things-up.md [80-83]](https://github.com/keyshade-xyz/keyshade/pull/358/files#diff-cef348a8823f15a58b87562625cba74999f427c52980164863ee234f45897d44R80-R83) ```diff -- 5432 -- 6379 -- 9000 -- 9001 +- PostgreSQL (5432) +- Redis (6379) +- Minio (9000) +- Minio Console (9001) ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 7 Why: The suggestion improves the readability of the port requirements by providing descriptions, which can help users quickly understand the necessary information. However, it is a minor enhancement.
    		7