Release checklist for v0.11

[choldgraf]

We have a few loose ends to tie up before releasing v0.11. We should finish the tasks below and then cut a release!

• Merge docs update Updating for new TOC structure #1321 (Note: Only Merge after Release is Available via PyPI and Conda-Forge)

Edit: I have moved these future release items to #1347

[mmcky]

@choldgraf @AakashGfude and I are working through the first two elements this week. @AakashGfude is also planning a review of sphinx-multitoc-numbering to ensure compatible with latest refactor.

[choldgraf]

Hey all - can I get a status update on some of these? We are starting to get issues of confused people who are running on master, and while it's not technically our problem since "it's bleeding edge", I don't want to keep fielding questions from people who are confused because the docs don't match master :-)

Are any of the items in my list above something we can delay to a future release?

[mmcky]

@choldgraf I have tested sphinx-multitoc-numbering and working well but we are able to keep using it as an extension so I am happy for that to slide to the next release (or a subsequent minor release) if that is helpful..

I have opened #1326 though which is based on the current master and reworked a little bit. I have updated link above. I wouldn't mind someone taking a quick look as a double check though as it updates a lot of test fixtures.

[mmcky]

| In-place lists in jupyterbook-lated executablebooks/sphinx-jupyterbook-latex#57

Let's not let this hold jupyter-book release up. We can add this feature through a subsequent minor release.

[choldgraf]

@chrisjsewell what do you think about bumping the MyST-NB update to 0.13 to a new release for Jupyter Book as well?

[chrisjsewell]

@chrisjsewell what do you think about bumping the MyST-NB update to 0.13 to a new release for Jupyter Book as well

@choldgraf I think you need to read the check list again 😜
(I.e. the answer is yes 👍 )

[mmcky]

@choldgraf sounds like you're good to merge the docs update :-).

[mmcky]

@choldgraf I'm guessing there might be a number of reports that builds are broken (due to the change in toc) so it might be a good idea to cut the new release on a monday so we aren't spending the weekend responding to various issue reports? 😄

[mmcky]

@chrisjsewell thanks heaps for adding the -o option. It makes migrating a breeze. It works so well -- almost makes we wonder if we should just build old _toc.yml through the auto-conversion and then just keep issuing warnings that the _toc.yml file needs to be updated :-)

[chrisjsewell]

sounds like you're good to merge the docs update

We don't want it to go "live" though until the release, since obviously the toc instructions are different to the current version

[mmcky]

sounds like you're good to merge the docs update

We don't want it to go "live" though until the release, since obviously the toc of instructions are different to the current version

Excellent Point 👍

[chrisjsewell]

think you need to read the check list again

Oh my bad, I guess they are (now) under future release. But yeh it's all good to go, apart from the updates to jupyter book. So it depends if you want to wait for then before releasing

[mmcky]

Sorry I moved it to future release thinking that's what you meant that it was OK to delay. I'm ok to wait until myst-nb update is ready for any jupyter-book release. I moved them back so you can decide @chrisjsewell. I also added a note re: merge of docs update.

[chrisjsewell]

The other thing we haven't done yet is update the cookiecutter. Not sure exactly how we want to approach this, since I imagine we want back-compatibility, such that if you are using jupyter-book pre 0.11 you get the old toc format and then the new one otherwise

[mmcky]

@TomasBeuzen would you have any time available to update the cookiecutter for the upcoming v0.11 release? The _toc.yml structure has changed and we will need to update the cookiecutter template.

I went to setup a PR but not sure how best to handle the version check. It would be great to preserve backward compatibility so need to check which jupyter-book is installed:

So for jupyter-book < v0.11

# Table of content
# Learn more at https://jupyterbook.org/customize/toc.html
#
- file: intro
- file: content
  sections:
    - file: markdown
    - file: notebooks

and for jupyter-book version >= 0.11

# Table of content
# Learn more at https://jupyterbook.org/customize/toc.html
#
format: jb-article
root: intro
sections:
- file: content
  sections:
  - file: markdown
  - file: notebooks

@chrisjsewell I think jb-article is the most natural conversion and is the one used by the migrate tool.

[TomasBeuzen]

@mmcky - yep I should be able to have a look into this tomorrow. Will let you know on progress.

[mmcky]

Thanks so much @TomasBeuzen. I saw the hooks folder -- might be the way to check for version but just not sure how it all works. Much appreciated.

[TomasBeuzen]

@mmcky - all done! I'll keep an eye on this to make sure nothing breaks when 0.11 is released. Thanks for the continued work on JB!

[mmcky]

thanks so much @TomasBeuzen that's a huge help.

[choldgraf]

closing this as we have now made a new release!