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?

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.

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