Skip to content

docs: add S3 configuration details for evaluation results in README and remote-provider documentation.#24

Merged
dmaniloff merged 3 commits intotrustyai-explainability:mainfrom
dmaniloff:doc-improvements
Oct 9, 2025
Merged

docs: add S3 configuration details for evaluation results in README and remote-provider documentation.#24
dmaniloff merged 3 commits intotrustyai-explainability:mainfrom
dmaniloff:doc-improvements

Conversation

@dmaniloff
Copy link
Copy Markdown
Collaborator

@dmaniloff dmaniloff commented Oct 9, 2025

Summary by Sourcery

Document S3 storage configuration for evaluation results by introducing environment variables and secret creation instructions

Documentation:

  • Add KUBEFLOW_RESULTS_S3_PREFIX and KUBEFLOW_S3_CREDENTIALS_SECRET_NAME entries to the README with example secret creation commands for AWS credentials
  • Update remote-provider.adoc to include instructions for configuring S3-based result storage

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Oct 9, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR extends the project documentation to support storing evaluation results in S3 by introducing two new environment variables and providing secret creation instructions, with corresponding updates to both the main README and the remote-provider guide.

Flow diagram for S3 credentials secret creation

flowchart TD
  A["User runs 'oc create secret generic' command"] --> B["Kubernetes Secret created with AWS credentials"] --> C["Ragas Evaluation Container uses secret to access S3"]
Loading

File-Level Changes

Change Details Files
Add S3 configuration environment variables to README
  • Introduced KUBEFLOW_RESULTS_S3_PREFIX for result storage location
  • Introduced KUBEFLOW_S3_CREDENTIALS_SECRET_NAME for AWS credentials secret
README.md
Provide AWS secret creation steps
  • Added example oc create secret generic command
  • Detailed required AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_DEFAULT_REGION literals
README.md
Update remote-provider documentation for S3 support
  • Documented usage of the new S3 env vars in the remote provider context
  • Aligned remote-provider.adoc configuration section with README changes
docs/modules/ROOT/pages/remote-provider.adoc

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@dmaniloff dmaniloff requested a review from adolfo-ab October 9, 2025 01:46
@dmaniloff dmaniloff merged commit 3bc6840 into trustyai-explainability:main Oct 9, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants