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

blob-storage-usage doc update #5931

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

Conversation

Ritesh-Udgata
Copy link

Building the Flyte docs locally

Prerequisites

Set up the build environment

In the flyteorg/flyte root directory do:

$ conda-lock install --name monodocs-env monodocs-environment.lock.yaml
$ conda activate monodocs-env
$ pip install ./flyteidl

This creates a new environment called monodocs-env with all the dependencies needed to build the docs. You can choose a different environment name if you like.

Building the docs

In the flyteorg/flyte root directory make sure you have activated the monodocs-env (or whatever you called it) environment and do:

$ make docs

The resulting html files will be in docs/_build/html.

Closes #4881

Copy link

welcome bot commented Oct 28, 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).

@davidmirror-ops
Copy link
Contributor

@Ritesh-Udgata thank you. Can you clarify if this is connected to an issue?

Copy link

codecov bot commented Nov 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.84%. Comparing base (13b3d82) to head (3624c41).
Report is 61 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #5931   +/-   ##
=======================================
  Coverage   36.84%   36.84%           
=======================================
  Files        1309     1309           
  Lines      130967   130967           
=======================================
+ Hits        48252    48259    +7     
+ Misses      78531    78524    -7     
  Partials     4184     4184           
Flag Coverage Δ
unittests-datacatalog 51.58% <ø> (ø)
unittests-flyteadmin 54.14% <ø> (+0.02%) ⬆️
unittests-flytecopilot 11.73% <ø> (ø)
unittests-flytectl 62.40% <ø> (ø)
unittests-flyteidl 6.92% <ø> (ø)
unittests-flyteplugins 53.64% <ø> (ø)
unittests-flytepropeller 43.00% <ø> (ø)
unittests-flytestdlib 55.41% <ø> (+0.01%) ⬆️

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.


🚨 Try these New Features:

@eapolinario
Copy link
Contributor

@ppiegaze , can you help investigate the CI failure in test-docs? Do we need to include this new file in some other file?

@davidmirror-ops
Copy link
Contributor

@Ritesh-Udgata can you pleas check the DCO error? steps to sign your commits are here

@Ritesh-Udgata
Copy link
Author

Ritesh-Udgata commented Nov 27, 2024

I have added sign off along with gpg signature to pass the DCO check. Am i eligible for swags ? If so could you reopen the form ? I am asking because this PR was approved two weeks ago approximately and I contributed to the code base during Hacktoberfest time period.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Approved yet unmerged PRs
Development

Successfully merging this pull request may close these issues.

[Docs] Provide documentation on where blob storage is accessed and which keys are being used
4 participants