feat: add .env.example for easier contributor onboarding#192
Open
adarshkumar23 wants to merge 1 commit intokubeflow:mainfrom
Open
feat: add .env.example for easier contributor onboarding#192adarshkumar23 wants to merge 1 commit intokubeflow:mainfrom
adarshkumar23 wants to merge 1 commit intokubeflow:mainfrom
Conversation
Contributors currently need to read through server/app.py and server-https/app.py source code to discover required environment variables. Add a documented .env.example listing all configuration options with default values and descriptions. Also ensure .env is gitignored to prevent credential leaks. Signed-off-by: Adarsh Kumar <adarsh23072005@gmail.com> Signed-off-by: adarshkumar23 <131923092+adarshkumar23@users.noreply.github.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add a documented
.env.examplefile listing all environment variables used by both servers, with default values and descriptions. Also ensure.envis gitignored.Problem
New contributors need to read through
server/app.pyandserver-https/app.pysource code to discover required environment variables (KSERVE_URL, MILVUS_HOST, MILVUS_PORT, etc). This slows down onboarding and local development setup.Changes
.env.example— documented template with all 8 env vars grouped by category.gitignore— added.envto prevent accidental credential commits