[Docs] Clarify what Resource is used when doing FlyteFile/Directory.download() or current_context().working_dir

[cosmicBboy]

Description

We need to mention in flytekit and flytesnacks that the Resource(ephemeral_storage=...) request is relevant when the user writes data to the task pod's disk.

• flytesnacks: https://docs.flyte.org/projects/cookbook/en/latest/auto/deployment/customizing_resources.html
• flytekit:
  • https://docs.flyte.org/projects/flytekit/en/latest/generated/flytekit.Resources.html#flytekit-resources
  • https://docs.flyte.org/projects/flytekit/en/latest/generated/flytekit.types.file.FlyteFile.html#flytekit.types.file.FlyteFile.download
  • https://docs.flyte.org/projects/flytekit/en/latest/generated/flytekit.types.directory.FlyteDirectory.html#flytekit.types.directory.FlyteDirectory: this is missing documentation on the download method
  • https://docs.flyte.org/projects/flytekit/en/latest/generated/flytekit.ExecutionParameters.html#flytekit.ExecutionParameters: this is missing documentation on the working_directory property

Are you sure this issue hasn't been raised already?

• Yes

Have you read the Code of Conduct?

• Yes

[wild-endeavor]

Thanks for making the ticket. Yes we also need to mention that the storage field in Resources doesn't do anything anymore. Actually it never did, iirc, we added it before K8s supported it and when support was added it came in the form of ephemeral-storage. but we are keeping it so as to not break people. I think we should add a deprecation message there as well unless we think it'll again be used one day?

[Kota-Karthik]

@samhita-alla @cosmicBboy
I am interested in doing this issue
So kindly assign me this issue
Thank You : )

[dado5688]

Hello, @cosmicBboy @wild-endeavor
I am interested in this issue, but I found that when I modify the flytekit/flytekit/types/directory/types.py it doesn't automatically modify the corresponding file via make html
flytekit/docs/build/html/_modules/flytekit/types/directory/types.html
and
flytekit/docs/build/html/generated/flytekit.types.directory.FlyteDirectory.html
I was wondering if there are some config file about make html that I can check if something is wrong.

[samhita-alla]

@dado5688, are the pages not updating? Running make html should incorporate all the changes you made into the docs. Can you share the commands you ran to build docs locally?

[dado5688]

Hi @samhita-alla , thanks for the response
I'm run the following steps
run make setup make doc-requirements.txt pip install -r doc-requirements.txt in the root directory in order
then run the make html in the docs directory after modify code
but it's only not update about this file's corresponding html file
since I also modify other file like this one and it's update to corresponding html file successfully.

but I just wondering that the description about paramters in here is also not show in here

BTW there have some error when I run make html, I don't know if this will be related.
https://drive.google.com/file/d/1UhbLY-wpSg_CbewwawRCzC-EUTOjBD5T/view?usp=sharing

[samhita-alla]

The warnings can be ignored but the other errors need to be fixed. Not sure why remote launchplans are being gathered while building the documentation.

[samhita-alla]

^^ This is the output I'm seeing in the terminal.

[dado5688]

got it ! thank you!

[github-actions]

Hello 👋, this issue has been inactive for over 9 months. To help maintain a clean and focused backlog, we'll be marking this issue as stale and will engage on it to decide if it is still applicable.
Thank you for your contribution and understanding! 🙏

[dec0dedd]

Hey, I'd like to work on this issue. Could it get assigned to me?

[davidmirror-ops]

@dec0dedd sure! We merged a major change to the docs structure yesterday, so please ensure your fork is in sync with the main branch as many sections moved to different location. Thank you!