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

rollouts: add development docs and releasing notes #3873

Merged
merged 2 commits into from
Mar 11, 2023

Conversation

natasha41575
Copy link
Contributor

This PR adds some docs for rollouts devs: dev setup, releasing notes, and how to run the controllers locally.

While writing this up, I found some gaps in the make targets and scripts and updated them here. Would appreciate if the reviewer can dogfood to make sure it is working properly :)

A note, I'm not familiar with all aspects of rollouts code so feedback on descriptions of each package is welcome.

@natasha41575 natasha41575 requested a review from a team as a code owner March 10, 2023 19:28
@natasha41575 natasha41575 requested review from yuwenma, droot and ChristopherFry and removed request for yuwenma March 10, 2023 19:28
Copy link
Contributor

@droot droot left a comment

Choose a reason for hiding this comment

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

This is fantastic. I have some minor comments, 🚢

rollouts/docs/development.md Show resolved Hide resolved
rollouts/docs/development.md Outdated Show resolved Hide resolved
rollouts/docs/development.md Show resolved Hide resolved
rollouts/docs/development.md Outdated Show resolved Hide resolved
rollouts/docs/releasing.md Show resolved Hide resolved
rollouts/docs/running-locally.md Show resolved Hide resolved
rollouts/docs/running-locally.md Outdated Show resolved Hide resolved
rollouts/docs/running-locally.md Outdated Show resolved Hide resolved
@natasha41575
Copy link
Contributor Author

Merging, test failures are unrelated.

@natasha41575 natasha41575 merged commit 70bdf1c into kptdev:main Mar 11, 2023
@natasha41575 natasha41575 deleted the rollouts/devguide branch March 11, 2023 22:07
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.

None yet

2 participants