You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
commenting because I can't self-assign. I would love to see some of the materials in our (MNE-Python's) docs get superseded by ecosystem-level tutorials. I'm imagining things like
standard GitHub setup for contributors (fork, clone, add upstream, don't open PRs from main, etc)
explanation of CIs and how to view their logs
project management / workflows. This one is more aimed at maintainers, and has the goal of making it easier for contributors from other parts of the ecosystem to jump in and contribute to other packages without too much friction. Here I'm thinking of things like pre-commit setup, PR merge criteria, etc: probably there won't be general agreement on something like PR merge criteria across the ecosystem, but we could at least agree upon a standard place to write down what the PR merge policy is, so that a new contrib could easily find that information (CONTRIBUTING.md?) regardless of what package they happen to be contributing to.
obviously there will be some degree of variability across packages in how each of these things are done, but that's an opportunity for figuring out which ones have a clear best-practice (that could be codified in a SPEC?) and which are cases of "reasonable packages will disagree". For the latter cases, the ecosystem-level tutorial would be either more conceptual (individual package docs fill in the details) or simply not exist.
we are working on some tutorial content but it will be focused around packaging.
This meant focusing entirely on shared infrastructure, not at all on content, and not about a tutorial about that infrastructure. As far as I see there are no content-related topics suggestions yet, if that's something you would be interested doing, it could go into a separate issue.
One thing I'd personally be interested in is seeing whether/how various tools can be used in conjunction with one another. For example, there are several tutorials sites (numpy-tutorials, nx-guides) built on top of the executable books stack that would also benefit from e.g. the thumbnail feature from sphinx-gallery. It's not immediately obvious how the executablebook sphinx extensions & sphinx-gallery can be used together.
In a similar but broader vein - I'd like to investigate the browser-native tooling and see how well/easily existing tutorial content (based on static site generation) is supported.
Activity
lwasser commentedon Apr 20, 2023
id love to participate here as well. we are working on some tutorial content but it will be focused around packaging.
drammock commentedon Apr 20, 2023
commenting because I can't self-assign. I would love to see some of the materials in our (MNE-Python's) docs get superseded by ecosystem-level tutorials. I'm imagining things like
main, etc)CONTRIBUTING.md?) regardless of what package they happen to be contributing to.obviously there will be some degree of variability across packages in how each of these things are done, but that's an opportunity for figuring out which ones have a clear best-practice (that could be codified in a SPEC?) and which are cases of "reasonable packages will disagree". For the latter cases, the ecosystem-level tutorial would be either more conceptual (individual package docs fill in the details) or simply not exist.
bsipocz commentedon Apr 20, 2023
This meant focusing entirely on shared infrastructure, not at all on content, and not about a tutorial about that infrastructure. As far as I see there are no content-related topics suggestions yet, if that's something you would be interested doing, it could go into a separate issue.
drammock commentedon Apr 20, 2023
new issue created (#21)
rossbar commentedon May 1, 2023
One thing I'd personally be interested in is seeing whether/how various tools can be used in conjunction with one another. For example, there are several tutorials sites (numpy-tutorials, nx-guides) built on top of the executable books stack that would also benefit from e.g. the thumbnail feature from sphinx-gallery. It's not immediately obvious how the executablebook sphinx extensions & sphinx-gallery can be used together.
In a similar but broader vein - I'd like to investigate the browser-native tooling and see how well/easily existing tutorial content (based on static site generation) is supported.
bsipocz commentedon May 11, 2023
I've just run into nbmake right now, and wonder how does that compare to nbval for notebook testing.