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

Add documentation on CI/CD #296

Open
lilyminium opened this issue Aug 8, 2023 · 4 comments
Open

Add documentation on CI/CD #296

lilyminium opened this issue Aug 8, 2023 · 4 comments
Assignees

Comments

@lilyminium
Copy link
Member

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 MDAnalysis/membrane-curvature#11 that we could build off.

@IAlibay IAlibay changed the title Add documentation on CI Add documentation on CI/CD Aug 8, 2023
@IAlibay IAlibay self-assigned this Aug 8, 2023
@IAlibay
Copy link
Member

IAlibay commented Aug 8, 2023

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
Copy link
Contributor

jandom commented Aug 18, 2023

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
Copy link
Member

IAlibay commented Aug 18, 2023

@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
Copy link
Contributor

jandom commented Aug 18, 2023 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants