Proposal: Move migration guides to a wiki #12476
Replies: 4 comments 3 replies
-
I am absolutely fine with this. |
Beta Was this translation helpful? Give feedback.
-
@mattpap do you have any comments? In another PR you said "let's continue on the wiki" but it was not clear it that as just for this release or if you were signaling support for this proposal. |
Beta Was this translation helpful? Give feedback.
-
@bokeh/core what does everyone think of limiting migration guides on the wiki to 1.0 and later? I think at this point we could decide to regard the 0.x releases to be of only historical interest, and if the information is actually desired, the old docs pages will still have it. |
Beta Was this translation helpful? Give feedback.
-
This work has been completed |
Beta Was this translation helpful? Give feedback.
-
@tcmetzger, @mattpap, @pavithraes, @ianthomas23, @philippjfr I would like to propose a change to how we publish migration guides. I would like to move all them to a wiki page, and then link a section header (automatically) from the release notes. This is for a few reasons:
Edit: here is what a Wiki page might look like (partial)
https://github.com/bokeh/bokeh/wiki/Migration-Guides
I would also like to standardized the exact list of subs-sections that each section (version) can have. This will help users with navigating the guides.
Note that is is possible to clone wikis:
https://docs.github.com/en/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages#cloning-wikis-to-your-computer
So there is no limitation to the web UI and it is still possible to collaborate on branches, etc.
I am willing to undertake the work to convert all the old migration guides as well as update the
bokeh-releases
sphinx extension to add a link to the relevant section automatically to the release notes on the docs.Beta Was this translation helpful? Give feedback.
All reactions