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(contribute): rewrite flyte contribute docs based on 4960 #5260

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

bearomorphism
Copy link

@bearomorphism bearomorphism commented Apr 21, 2024

Tracking issue

NA

Why are the changes needed?

The contribution guide of flyte can be improved.

What changes were proposed in this pull request?

Rewrote the contribution guide of flyte.

How was this patch tested?

Setup process

Screenshots

Check all the applicable boxes

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

Related PRs

#4960

Docs link

Copy link

welcome bot commented Apr 21, 2024

Thank you for opening this pull request! 🙌

These tips will help get your PR across the finish line:

  • Most of the repos have a PR template; if not, fill it out to the best of your knowledge.
  • Sign off your commits (Reference: DCO Guide).

@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. documentation Improvements or additions to documentation labels Apr 21, 2024
Copy link

codecov bot commented Apr 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.78%. Comparing base (7287470) to head (ca91eb0).
Report is 26 commits behind head on master.

❗ Current head ca91eb0 differs from pull request most recent head fc28fef. Consider uploading reports for the commit fc28fef to get more accurate results

Additional details and impacted files
@@             Coverage Diff             @@
##           master    #5260       +/-   ##
===========================================
+ Coverage   58.60%   76.78%   +18.17%     
===========================================
  Files         568       18      -550     
  Lines       51121     1516    -49605     
===========================================
- Hits        29958     1164    -28794     
+ Misses      18748      288    -18460     
+ Partials     2415       64     -2351     
Flag Coverage Δ
unittests 76.78% <ø> (+18.17%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

jasonlai1218
jasonlai1218 previously approved these changes Apr 21, 2024
Copy link
Contributor

@jasonlai1218 jasonlai1218 left a comment

Choose a reason for hiding this comment

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

LGTM

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Apr 21, 2024

* Install `conda-lock <https://github.com/conda/conda-lock>`__.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we leave these steps in as an alternative to the steps below? You can move them down and put them in a "Alternative conda-lock setup steps" section.

Copy link
Author

Choose a reason for hiding this comment

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

Sure, but I am not sure how to build the Flyte doc by simply installing conda-lock. I guess this is only relevant to #4862, and we have to revert part of #4960 in order to make the alternative work.

@MortalHappiness Is conda-lock needed by make dev-docs?

Copy link
Contributor

Choose a reason for hiding this comment

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

@bearomorphism No. conda-lock is not needed by using make dev-docs because it is already installed in the Dockerfile.

Copy link
Author

Choose a reason for hiding this comment

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

I can add the following steps back as an alternative.

To build the Flyte docs locally you will need the following prerequisites:
* Install ``conda``.
* We recommend Miniconda installed with an `official installer <https://docs.conda.io/projects/miniconda/en/latest/index.html#latest-miniconda-installer-links>`__.
* Install `conda-lock <https://github.com/conda/conda-lock>`__.
* In the ``flyteorg/flyte`` root directory run:
* ``conda-lock install --name monodocs-env monodocs-environment.lock.yaml``
* ``conda activate monodocs-env``
* ``pip install ./flyteidl``

Copy link
Author

Choose a reason for hiding this comment

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

Done.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants