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 Environment Setup Guide for MonoRepo #4257

Conversation

Future-Outlier
Copy link
Member

@Future-Outlier Future-Outlier commented Oct 18, 2023

Doc link

https://flyte--4257.org.readthedocs.build/en/4257/community/contribute.html

Tracking issue

#4188

Describe your changes

  • Update the "hello world" example in flytesnacks
  • Update the setup guide to reflect the Monorepo structure.
  • Update the flytekit install plugins guideline, since flytekitplugins doesn't support lazy import.

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Screenshots

image
image

Note to reviewers

@Yicheng-Lu-llll, @samhita-alla, @pingsutw please take a look, thanks a lot!

Signed-off-by: Future Outlier <[email protected]>
@Future-Outlier Future-Outlier changed the title contribution guide improvement [Docs] Update Development Environment Setup Guide for MonoRepo Oct 18, 2023
nit
Signed-off-by: Future Outlier <[email protected]>
rsts/community/contribute.rst Outdated Show resolved Hide resolved
rsts/community/contribute.rst Outdated Show resolved Hide resolved
rsts/community/contribute.rst Outdated Show resolved Hide resolved
Future Outlier added 2 commits October 18, 2023 15:21
Signed-off-by: Future Outlier <[email protected]>
Signed-off-by: Future Outlier <[email protected]>
@samhita-alla
Copy link
Contributor

@pingsutw, can this PR be merged now?

@pingsutw pingsutw merged commit b30cb72 into flyteorg:master Oct 25, 2023
10 checks passed
# Step 3.2: Generate code, fix lint errors and run unit tests for {flyteadmin}.
# Note, flyteidl does not have unit tests, so you can skip the `make test_unit` command.
# Note, flytestdlib only have `make generate` command.
make generate
Copy link
Member

Choose a reason for hiding this comment

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

@Future-Outlier I think we still need to execute the following commands:

make generate
make lint
make test_unit

For instance, to generate the protobuf code, I guess we still need to run make generate under flyteidl folder? Correct me if I am wrong.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes you are right, XD.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants