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

Update README #208

Merged
merged 2 commits into from
Nov 1, 2024
Merged

Update README #208

merged 2 commits into from
Nov 1, 2024

Conversation

josejulio
Copy link
Contributor

  • trying to give it a more common structure
  • having all calls on the "default" port and specifying that there are other ports used on the different run scenarios

PR Template:

Describe your changes

  • ...

Ticket reference (if applicable)

Fixes #

Checklist

  • Are the agreed upon acceptance criteria fulfilled?

  • Was the 4-eye-principle applied? (async PR review, pairing, ensembling)

  • Do your changes have passing automated tests and sufficient observability?

  • Are the work steps you introduced repeatable by others, either through automation or documentation?

    • If automation is possible but not done due to other constraints, a ticket to the tech debt sprint is added
    • An SOP (Standard Operating Procedure) was created
  • The Changes were automatically built, tested, and - if needed, behind a feature flag - deployed to our production environment. (Please check this when the new deployment is done and you could verify it.)

  • Are the agreed upon coding/architectural practices applied?

  • Are security needs fullfilled? (e.g. no internal URL)

  • Is the corresponding Ticket in the right state? (should be on "review" now, put to done when this change made it to production)

  • For changes to the public API / code dependencies: Was the whole team (or a sufficient amount of ppl) able to review?

 - trying to give it a more common structure
 - having all calls on the "default" port and specifying that there are
   other ports used on the different run scenarios
@josejulio
Copy link
Contributor Author

Tried all the commands under the default use case - added some notes about different scenarios.

@josejulio josejulio requested a review from tonytheleg October 25, 2024 23:31
Copy link
Contributor

@tonytheleg tonytheleg left a comment

Choose a reason for hiding this comment

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

lgtm!

@josejulio josejulio merged commit 59d4ad8 into project-kessel:main Nov 1, 2024
9 checks passed
@josejulio josejulio deleted the update-readme branch November 1, 2024 13:13
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