Merged
Conversation
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
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.
This pull request adds essential project documentation and clarifies the configuration and operating modes of the KrakenKey Probe. It introduces a changelog, contribution and security guidelines, and significantly expands the
README.mdto better explain usage, deployment, and operational details. The.env.examplefile is updated to reflect the new supported modes.Key documentation and configuration improvements:
Project documentation:
CHANGELOG.mdfollowing Keep a Changelog and Semantic Versioning to record all notable changes and initial features.CONTRIBUTING.mdwith guidelines for setup, development workflow, code conventions, and issue reporting.SECURITY.mdoutlining vulnerability reporting, supported versions, and security considerations for API keys, container, and network.Configuration and usage clarification:
.env.exampleto document the newhostedmode in addition tostandaloneandconnected.README.md:standalone,connected,hosted), including configuration precedence, environment variables, and API key requirements. [1] [2]/healthz,/readyz) with example responses. [1] [2]