dmwm / WMCore

Core workflow management components for CMS.
Apache License 2.0
46 stars 107 forks source link

Refactoring documentation about WM deployment with Docker and venv #12161

Open anpicci opened 1 week ago

anpicci commented 1 week ago

Impact of the new feature Have a more user-friendly documentation about WM agent deployment with Docker and venv. This particularly needs to be done before running the next training sessions on debugging (https://github.com/dmwm/WMCore/issues/11849)

Is your feature request related to a problem? Please describe. The documentation is too scattered across the MKDocs repo

Describe the solution you'd like Merge these documents into one.

Describe alternatives you've considered None

amaltaro commented 1 week ago

@anpicci we briefly discussed this yesterday, but now that I read its initial description, I just wanted to share some extra information and perspective here.

If we really decide to refactor the WMAgent documentation, then I think we could add this ticket as part of the meta-issue https://github.com/dmwm/WMCore/issues/11875 (which already has a ticket for legacy/out-dated content); and perhaps consider it as normal plan instead of Ops.

If the goal is only to describe/improve the Docker and virtual-environment based deployments, then yes, this ticket looks self-container. In addition, I think a good starting point is https://gitlab.cern.ch/dmwm/wmcore-docs/-/blob/master/docs/wmcore/WMAgent-in-Docker.md, which already gives a brief description of the docker deployment.

For the outcome - especially if it involves content removal - I would ask you and @todor-ivanov to actually provide a merge request instead of pushing changes upstream. This way others have the opportunity to look into the actual changes and identify anything that might be undesired.