MDAnalysis / UserGuide

User Guide for MDAnalysis
https://userguide.mdanalysis.org
22 stars 31 forks source link

Add documentation on CI/CD #296

Open lilyminium opened 11 months ago

lilyminium commented 11 months ago

Is your feature request related to a problem? Please describe. We should document our CI, which is quite complicated. This will help people who are new to development (e.g. MDAkits) as well as spread the load for maintenance in MDAnalysis libraries. It's not clear that the documentation should actually live at the user guide, instead of e.g. the wiki of the MDAnalysis core/ or maybe MDAKits documentation, but having it written down somewhere would be a good start.

Describe the solution you'd like Start with docs. There's some pre-existing comments at https://github.com/MDAnalysis/membrane-curvature/issues/11 that we could build off.

IAlibay commented 11 months ago

I'll make this a me problem since I don't think anyone else has a clear view of what our CI/CD does anymore, but honestly this might be a good place for a coredev to come in and try to get an idea of what everything does and write it down.. I'd probably be more likely to sit in a call and draw diagrams for a while than sit down and find time to write stuff down.

jandom commented 11 months ago

Well, okay I'm pretty versed with CI/CD (not just GHA) so maybe I can put my hand up? How are the next 1-2 weeks looking for you? Release-level busy, I'm guessing? Then my paternity ends and it'll be much tighter time-wise

IAlibay commented 11 months ago

@jandom unfortunately I've managed to catch a summer cold (so this weekend is pretty much not happening) and I'm out of office next week. I should have time week of the 29th.

jandom commented 11 months ago

Ah man, sorry to hear, hope you get well soon and no worries!

On Fri, Aug 18, 2023 at 17:18 Irfan Alibay @.***> wrote:

@jandom https://github.com/jandom unfortunately I've managed to catch a summer cold (so this weekend is pretty much not happening) and I'm out of office next week. I should have time week of the 29th.

— Reply to this email directly, view it on GitHub https://github.com/MDAnalysis/UserGuide/issues/296#issuecomment-1684070591, or unsubscribe https://github.com/notifications/unsubscribe-auth/AADAVG576CIAFQGG4PPEMXLXV6BT7ANCNFSM6AAAAAA3JDHS5Y . You are receiving this because you were mentioned.Message ID: @.***>