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

Documentation lacks HTEx and Config #575

Open
4 tasks
WardLT opened this issue Aug 19, 2021 · 0 comments
Open
4 tasks

Documentation lacks HTEx and Config #575

WardLT opened this issue Aug 19, 2021 · 0 comments
Labels
Documentation Doc improvements/fixes

Comments

@WardLT
Copy link
Contributor

WardLT commented Aug 19, 2021

Is your feature request related to a problem? Please describe.
Setting up an endpoint was complicated by some key details being hard to find in the documentation:

  • HighThroughputExecutor is not listed in the autodocs
  • Config file is not listed in the autodocs either

Both these made figuring out how to configure my application difficult, although that was benefited by the example configuration for Theta. However,

  • The example documentation for Theta references a "~/setup_funcx_test_env.sh" that is not listed in the documentation.
  • You should also provide general advice for making sure workers have the correct Python environments. E.g., is this given in the worker activitation, when launching the FuncX endpoint, etc?

Describe the solution you'd like

These improvements to the documentation being made.

Describe alternatives you've considered

N/A

@WardLT WardLT added the Documentation Doc improvements/fixes label Aug 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Doc improvements/fixes
Projects
None yet
Development

No branches or pull requests

1 participant