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

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

Merged
merged 2 commits into from
Jul 13, 2024

Conversation

rajdip-b
Copy link
Member

@rajdip-b rajdip-b commented Jul 13, 2024

PR Type

Documentation


Description

  • Removed Docker Compose instructions from running-the-api.md.
  • Added detailed Docker Compose setup instructions in setting-things-up.md, including:
    • Steps to start dependencies (PostgreSQL, Redis, Minio) using Docker Compose.
    • Required ports for the services.
    • Troubleshooting tips for PostgreSQL.
    • Instructions for shutting down the Docker infrastructure.

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

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No key issues to review

    Copy link
    Contributor

    codiumai-pr-agent-free bot commented Jul 13, 2024

    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:

    -## 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]

    -## 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]

    -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]

    -- 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** <!-- /improve --apply_suggestion=2 -->
    <details><summary>Suggestion importance[1-10]: 8</summary>
    
    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.
    
    
    </details></details></td><td align="center">8
    
    </td></tr><tr><td rowspan="1"><strong>Maintainability</strong></td>
    <td>
    <details><summary>Improve the readability of the port requirements by using a bulleted list with descriptions</summary>
    
    ___
    
    
    **To enhance the clarity and readability of the documentation, consider using a <br/>bulleted list for the ports that need to be free. This format can make it easier for <br/>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

    @rajdip-b rajdip-b merged commit c2de603 into develop Jul 13, 2024
    5 checks passed
    @rajdip-b rajdip-b deleted the docs/updated-setting-things-up branch July 13, 2024 17:55
    rajdip-b pushed a commit that referenced this pull request Jul 29, 2024
    ## [2.3.0](v2.2.0...v2.3.0) (2024-07-29)
    
    ### 🚀 Features
    
    * **api:** Add pagination metadata to Environment module ([#382](#382)) ([9baa344](9baa344))
    * **api:** Add pagination metadata to Event module ([#394](#394)) ([60010b4](60010b4))
    * **api:** Add pagination metadata to Integration module ([#391](#391)) ([0372e36](0372e36))
    * **api:** Add pagination metadata to Project module ([#393](#393)) ([bc274fd](bc274fd))
    * **api:** Add pagination metadata to Secret module ([#389](#389)) ([c4cc667](c4cc667))
    * **api:** Add pagination metadata to Variable module ([#390](#390)) ([be6aabf](be6aabf))
    * **api:** Add pagination metadata to Workspace module  ([#387](#387)) ([a08c924](a08c924))
    * **api:** Add pagination metadata to Workspace Role module ([#388](#388)) ([d8e8f49](d8e8f49))
    * **api:** Create a paginate method ([#379](#379)) ([09576f1](09576f1))
    * **api:** Create endpoint for fetching all revisions of a [secure] ([#303](#303)) ([de2b602](de2b602))
    * **api:** Create endpoint for fetching all revisions of a variable ([#304](#304)) ([9abddc1](9abddc1))
    * **cli:** Improved the DX for list profile ([#334](#334)) ([6bff496](6bff496))
    * **platform:** Add warning sonner toast for invalid otp ([#335](#335)) ([21513f5](21513f5))
    
    ### 🐛 Bug Fixes
    
    * **cli:** Added parent directory check ([#359](#359)) ([538ea7f](538ea7f))
    * **platform:** Platform types fixes ([#374](#374)) ([8e9d9ff](8e9d9ff))
    
    ### 📚 Documentation
    
    * Added docker details in setting-things-up.md ([#358](#358)) ([ed5093a](ed5093a))
    * Update postman workspace link ([d6aba27](d6aba27))
    * Updated env and cli docs ([1213d2a](1213d2a))
    
    ### 🔧 Miscellaneous Chores
    
    * Added next backend url in .env.example ([5695254](5695254))
    * **api-client:** Added pagination structure ([a70e957](a70e957))
    * **api-client:** Fixed test script ([ad70819](ad70819))
    * **api-client:** Removed try-catch from tests in environment ([a64e48c](a64e48c))
    * **api:** Add user cache for optimization ([#386](#386)) ([8d730b5](8d730b5))
    * **api:** Alter cache rehydration interval ([f5f9eec](f5f9eec))
    * **api:** Fixed naming error in variable controller ([0c5a380](0c5a380))
    * **api:** Improve handling of edge cases for paginate module ([#402](#402)) ([8591487](8591487))
    * **api:** Minor updates to user service ([249d778](249d778))
    * **api:** Skip workspace creation when user is admin ([#376](#376)) ([13f6c59](13f6c59))
    * **ci:** Add docker check   ([#383](#383)) ([3119001](3119001))
    * **ci:** Add names to CI files ([1a7e5f6](1a7e5f6))
    * **ci:** Add validate CLI pipeline ([#373](#373)) ([a91df6c](a91df6c))
    * **ci:** Adding validate pipeline ([#372](#372)) ([23cf3b3](23cf3b3))
    * **ci:** Disabled platform and api deployments ([74d601a](74d601a))
    * **ci:** Fixed deployment scripts ([12e35db](12e35db))
    * **ci:** Fixed platform script ([d783f2a](d783f2a))
    * **CI:** Include migration deployment in API deploy pipeline ([dbd5222](dbd5222))
    * **CI:** Separated deployment and docker build jobs ([090e193](090e193))
    * **CI:** Setup inter-job dependency ([1756727](1756727))
    * **ci:** Update auto-assign.yaml ([#375](#375)) ([91e0ec1](91e0ec1))
    * **cli:** Changed objects to classes ([#306](#306)) ([c83f2db](c83f2db))
    * Removed Minio config ([8feb83a](8feb83a))
    * Updated deployment scripts and added health check in platform ([fcc1c3f](fcc1c3f))
    
    ### 🔨 Code Refactoring
    
    * **api:** Updated path of some endpoints in project controller ([9502678](9502678))
    * **api:** Updated Redis provider ([33491a1](33491a1))
    rajdip-b pushed a commit that referenced this pull request Jul 29, 2024
    ## [2.3.0](v2.2.0...v2.3.0) (2024-07-29)
    
    ### 🚀 Features
    
    * **api:** Add pagination metadata to Environment module ([#382](#382)) ([9baa344](9baa344))
    * **api:** Add pagination metadata to Event module ([#394](#394)) ([60010b4](60010b4))
    * **api:** Add pagination metadata to Integration module ([#391](#391)) ([0372e36](0372e36))
    * **api:** Add pagination metadata to Project module ([#393](#393)) ([bc274fd](bc274fd))
    * **api:** Add pagination metadata to Secret module ([#389](#389)) ([c4cc667](c4cc667))
    * **api:** Add pagination metadata to Variable module ([#390](#390)) ([be6aabf](be6aabf))
    * **api:** Add pagination metadata to Workspace module  ([#387](#387)) ([a08c924](a08c924))
    * **api:** Add pagination metadata to Workspace Role module ([#388](#388)) ([d8e8f49](d8e8f49))
    * **api:** Create a paginate method ([#379](#379)) ([09576f1](09576f1))
    * **api:** Create endpoint for fetching all revisions of a [secure] ([#303](#303)) ([de2b602](de2b602))
    * **api:** Create endpoint for fetching all revisions of a variable ([#304](#304)) ([9abddc1](9abddc1))
    * **cli:** Improved the DX for list profile ([#334](#334)) ([6bff496](6bff496))
    * **platform:** Add warning sonner toast for invalid otp ([#335](#335)) ([21513f5](21513f5))
    
    ### 🐛 Bug Fixes
    
    * **cli:** Added parent directory check ([#359](#359)) ([538ea7f](538ea7f))
    * **platform:** Platform types fixes ([#374](#374)) ([8e9d9ff](8e9d9ff))
    
    ### 📚 Documentation
    
    * Added docker details in setting-things-up.md ([#358](#358)) ([ed5093a](ed5093a))
    * Update postman workspace link ([d6aba27](d6aba27))
    * Updated env and cli docs ([1213d2a](1213d2a))
    
    ### 🔧 Miscellaneous Chores
    
    * Added next backend url in .env.example ([5695254](5695254))
    * **api-client:** Added pagination structure ([a70e957](a70e957))
    * **api-client:** Fixed test script ([ad70819](ad70819))
    * **api-client:** Removed try-catch from tests in environment ([a64e48c](a64e48c))
    * **api:** Add user cache for optimization ([#386](#386)) ([8d730b5](8d730b5))
    * **api:** Alter cache rehydration interval ([f5f9eec](f5f9eec))
    * **api:** Fixed naming error in variable controller ([0c5a380](0c5a380))
    * **api:** Improve handling of edge cases for paginate module ([#402](#402)) ([8591487](8591487))
    * **api:** Minor updates to user service ([249d778](249d778))
    * **api:** Skip workspace creation when user is admin ([#376](#376)) ([13f6c59](13f6c59))
    * **ci:** Add docker check   ([#383](#383)) ([3119001](3119001))
    * **ci:** Add names to CI files ([1a7e5f6](1a7e5f6))
    * **ci:** Add validate CLI pipeline ([#373](#373)) ([a91df6c](a91df6c))
    * **ci:** Adding validate pipeline ([#372](#372)) ([23cf3b3](23cf3b3))
    * **ci:** Disabled platform and api deployments ([74d601a](74d601a))
    * **ci:** Fixed deployment scripts ([12e35db](12e35db))
    * **ci:** Fixed platform script ([d783f2a](d783f2a))
    * **CI:** Include migration deployment in API deploy pipeline ([dbd5222](dbd5222))
    * **CI:** Separated deployment and docker build jobs ([090e193](090e193))
    * **CI:** Setup inter-job dependency ([1756727](1756727))
    * **ci:** Update auto-assign.yaml ([#375](#375)) ([91e0ec1](91e0ec1))
    * **cli:** Changed objects to classes ([#306](#306)) ([c83f2db](c83f2db))
    * Removed Minio config ([8feb83a](8feb83a))
    * Updated deployment scripts and added health check in platform ([fcc1c3f](fcc1c3f))
    
    ### 🔨 Code Refactoring
    
    * **api:** Updated path of some endpoints in project controller ([9502678](9502678))
    * **api:** Updated Redis provider ([33491a1](33491a1))
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant