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

docs: Update development setup with preferred kind-based approach #25535

Merged
merged 1 commit into from Jun 15, 2023

Conversation

christarazi
Copy link
Member

For a long time, we discussed how unreliable / clunky it is to use the
Vagrant-based development setup. It is a massive struggle for new
contributors as well.

Many developers hacked their own scripts to make it work, and even more
avoid using it altogether. Many in the community including myself use
kind already. It is simply much easier to set up and maintain, without
being a drain on your local machine in terms of resources.

Let's finally document what many in the community have already been
running.

Signed-off-by: Chris Tarazi chris@isovalent.com

@christarazi christarazi added kind/enhancement This would improve or streamline existing functionality. release-note/misc This PR makes changes that have no direct user impact. labels May 18, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot added dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. and removed dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. labels May 18, 2023
@christarazi christarazi added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. sig/contributing Impacts contribution workflow, guidelines, and tools. labels May 18, 2023
@christarazi christarazi marked this pull request as ready for review May 18, 2023 21:15
@christarazi christarazi requested review from a team as code owners May 18, 2023 21:15
@christarazi

This comment was marked as outdated.

Copy link
Member

@bimmlerd bimmlerd left a comment

Choose a reason for hiding this comment

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

nice - tested on M1 Pro for MacOS, works 👍

Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

Looks good to me. Do you plan to document the config for clusters in this PR?

@christarazi christarazi force-pushed the pr/christarazi/better-dev-setup-docs branch from 9195288 to 9996d77 Compare May 25, 2023 21:11
@christarazi
Copy link
Member Author

@qmonnet Done!

Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

Thanks!

@zacharysarah
Copy link
Contributor

@christarazi 👋🏻

I'm noting that I didn't make this fully exhaustive and update every single reference in the docs to mention this, etc, so I can get early feedback first.

Feel free to re-assign me for review when you're ready!

@zacharysarah zacharysarah removed their request for review May 25, 2023 22:35
@christarazi
Copy link
Member Author

Oops @zacharysarah, I've hidden that comment now because it's no longer up-to-date. It's ready for review. 🙂

@aojea
Copy link
Contributor

aojea commented May 26, 2023

LGTM

But I'm clearly biased ;)

Copy link
Contributor

@zacharysarah zacharysarah left a comment

Choose a reason for hiding this comment

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

@christarazi Some changes required, otherwise LGTM.

Documentation/contributing/development/dev_setup.rst Outdated Show resolved Hide resolved
Documentation/contributing/development/dev_setup.rst Outdated Show resolved Hide resolved
Documentation/contributing/development/dev_setup.rst Outdated Show resolved Hide resolved
Documentation/contributing/development/dev_setup.rst Outdated Show resolved Hide resolved
Documentation/contributing/development/dev_setup.rst Outdated Show resolved Hide resolved
Documentation/contributing/development/dev_setup.rst Outdated Show resolved Hide resolved
Documentation/contributing/development/dev_setup.rst Outdated Show resolved Hide resolved
Documentation/contributing/development/dev_setup.rst Outdated Show resolved Hide resolved
@christarazi christarazi force-pushed the pr/christarazi/better-dev-setup-docs branch from 9996d77 to 298524e Compare May 29, 2023 19:13
@christarazi
Copy link
Member Author

Thanks @zacharysarah! Comments addressed.

For a long time, we discussed how unreliable / clunky it is to use the
Vagrant-based development setup. It is a massive struggle for new
contributors as well.

Many developers hacked their own scripts to make it work, and even more
avoid using it altogether. Many in the community including myself use
kind already. It is simply much easier to set up and maintain, without
being a drain on your local machine in terms of resources.

Let's finally document what many in the community have already been
running.

Signed-off-by: Chris Tarazi <chris@isovalent.com>
@christarazi christarazi force-pushed the pr/christarazi/better-dev-setup-docs branch from 298524e to e6cd37e Compare May 29, 2023 19:15
@christarazi christarazi added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Jun 14, 2023
@christarazi
Copy link
Member Author

Addresses review comments and have other approving reviews already, marking ready to merge.

@aanm aanm merged commit a68e252 into main Jun 15, 2023
36 checks passed
@aanm aanm deleted the pr/christarazi/better-dev-setup-docs branch June 15, 2023 11:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. kind/enhancement This would improve or streamline existing functionality. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact. sig/contributing Impacts contribution workflow, guidelines, and tools.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants