mystmd icon indicating copy to clipboard operation
mystmd copied to clipboard

Launch the MyST -> Jupyter Book parity project

Open choldgraf opened this issue 1 year ago • 3 comments

To begin, we'd like to communicate our intent to use MyST as a Jupyter Book build engine, and define the basic framework for organizing and prioritizing our work internally.

Progress towards goal

This is the first step towards the following goal:

  • https://github.com/executablebooks/mystmd/issues/1000

This will give us a foundation to begin iterating, with the goal of getting new functionality in front of users as quickly as we can so that we can learn and improve with them.

Strategy and coordination

  • [x] https://github.com/executablebooks/mystmd/issues/1113
  • [x] Add enough information to get started: #1106
  • [x] #1146
  • [ ] Blog post about intent to offer MyST document engine as a backend

choldgraf avatar Mar 18 '24 18:03 choldgraf

We can still identify and start talking to one or two communities now, or stakeholders in those communities, it doesn't need to be blocked by the blog post but the blog post will be helpful for enabling the message to be better communicated across those communities.

stevejpurves avatar Mar 20 '24 08:03 stevejpurves

I've removed https://github.com/executablebooks/mystmd/issues/618 from this list, as we've discussed that it should be the responsibility of JB2 to convert Sphinx-style glossaries.

agoose77 avatar Apr 18 '24 11:04 agoose77

Spoke a bit with @agoose77 about this today. We've got the two "guiding principles" issues finished up, one of them is merged and the other we'll leave open and use it as a reference for our development-focused initiative:

  • #1106

The only remaining thing for this one is to get the blog post out. @agoose77 is going to finish up a draft and get feedback from one or two communities and then I think we can post it soon

choldgraf avatar May 08 '24 20:05 choldgraf

Current status

  • We've got a draft blog post ready to go
  • We've got a JEP pre-proposal ready to go: https://github.com/jupyter/enhancement-proposals/issues/122

The pre-proposal has gotten positive feedback as well, and one person asked if we'd be willing to speak with the software steering council on Monday to answer any questions people may have.

Current plan

  • Attend the SSC meeting on Monday (8am California time)
  • If that goes positively, then convert the JEP into markdown and make it a PR
  • Link the PR from the blog post, and then post the blog post as well

choldgraf avatar May 17 '24 14:05 choldgraf

OK all - I think the final two outputs of this one are done:

  • Blog post announcing jupyter book using mystmd: https://github.com/executablebooks/meta/pull/1177/
  • JEP for incorporating as Jupyter sub-project: https://github.com/jupyter/enhancement-proposals/pull/123

I suggest we close this one and focus on the development-oriented initiative here w/ @agoose77 :

  • #1106

choldgraf avatar May 22 '24 03:05 choldgraf