search

flux-framework / flux-core

core services for the Flux resource management framework
GNU Lesser General Public License v3.0
168 stars 50 forks source link

doc: improve housekeeping documentation #6425

Closed garlick closed 2 weeks ago

garlick commented 2 weeks ago

Problem: the admin guide does not discuss housekeeping, and the flux-housekeeping(1) and flux-config-job-manager(5) man pages list housekeeping as EXPERIMENTAL.

I think we're past the EXPERIMENTAL phase at this point. Drop that.

Add a TROUBLESHOOTING section to flux-housekeeping(1).

Rework the prolog/epilog section of the admin guide to include housekeeping and a general intro that describes the roles of the three scripts.

garlick commented 2 weeks ago

Fixed a typo and rebased after #6427 was merged, and I'll set MWP. Thanks!

codecov[bot] commented 2 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 83.65%. Comparing base (80527ea) to head (82cf509). Report is 4 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #6425 +/- ## ========================================== + Coverage 83.63% 83.65% +0.01% ========================================== Files 524 524 Lines 87637 87637 ========================================== + Hits 73295 73310 +15 + Misses 14342 14327 -15 ``` [see 14 files with indirect coverage changes](https://app.codecov.io/gh/flux-framework/flux-core/pull/6425/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flux-framework)