Added extra information and user-action summaries to 7 migration docs. #6850
Conversation
|
|
ericsnekbytes
changed the title
|
Thx @ericsnekbytes I have gone across your changes and they make sense to me. |
docs/source/migrate_to_notebook7.md
Outdated
|
|
||
| - If you NEED to maintain compatibility with the Classic Notebook for extensions | ||
| or other customizations that are critical to your workflows, you can switch to | ||
| [nbclassic], the new home for users who need to maintain compatibility with the |
There was a problem hiding this comment.
The "new home" and "maintain" words in this sentence give the somewhat misleading idea that nbclassic will be maintained in the long run?
NBClassic is supposed to help with the transition to Notebook 7, but shouldn't be seen as an "alternative" to Notebook 7 long term.
There was a problem hiding this comment.
Yeah it's a subtle thing to communicate. We want people who need it to know it's there and to use it, without giving the impression it's a permanent thing. I'll add a bit/re-work to add some clarity. Thanks!
There was a problem hiding this comment.
I posted a comment in the team compass issue to see if the EC can provide guidance for the documentation as well, since they will be looking at the blog post: jupyter/notebook-team-compass#24 (comment)
There was a problem hiding this comment.
I have updated this portion with a recent commit, and we can modify as needed after the EC takes a look.
docs/source/migrate_to_notebook7.md
Outdated
| [nbclassic], the new home for users who need to maintain compatibility with the | ||
| old notebook interface | ||
|
|
||
| ## Why things are changing |
There was a problem hiding this comment.
Maybe something like the following?
| ## Why things are changing | |
| ## Why a new major version? |
There was a problem hiding this comment.
I think this one is worth keeping, because it simplifies the language and reduces jargon (related to semantic versioning / "major version", which not everyone is going to know about). Maybe there's a plain-language compromise, like "Why the big version change?" Is it the "major-version-number-is-being-incremented-to-7" idea that you want to communicate here?
There was a problem hiding this comment.
@jtpio Is "Why the big version change?" good? Edit: I've just pushed that, let me know if there's anything else.
There was a problem hiding this comment.
"big" sounds ambiguous: what does big mean?
If this is because of the word "major" then maybe we could just drop it and only keep "Why a new version"?
There was a problem hiding this comment.
Big was supposed to communicate that sweeping changes are taking place in plain-language (without the "major version" jargon and the odd-sounding/confusing phrasing that it necessitates...."Why a new major version" sounds odd, but "Why a major new version" does not...probably related to points noted in this BBC article...).
I've pushed an update to just "Why a new version?" which I think is good enough, let me know if you've got any other suggestions.
Co-authored-by: Jeremy Tuloup <[email protected]>
Co-authored-by: Jeremy Tuloup <[email protected]>
|
Looks like it needs a lint pass to fix the CI check ( |
|
That's done. |
|
Thanks! |
See #6851, this PR adds extra information to the migrate_to_notebook7 doc: