globus / globus/globus-compute

Documentation lacks HTEx and Config

Open
#575 0 comments 0 reactions 0 assignees View on GitHub
Documentation
Dominant language
Python
Stars
162
Forks
53
Avg merge
15h 29m
Merged PRs (30d)
26

Description

**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

Contributor guide

Open the contributing guide

Research direction

Start by locating the autodocs entries for HighThroughputExecutor and Config, then review the Theta example and references to ~/setup_funcx_test_env.sh. Document the missing entries, explain the setup script, and clarify when and how workers receive the correct Python environments.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.