search

backstage / mkdocs-techdocs-core

The core MkDocs plugin used by Backstage's TechDocs as a wrapper around multiple MkDocs plugins and Python Markdown extensions
Apache License 2.0
83 stars 61 forks source link

mkdocs and mkdocs-material updates #145

Closed SimonMarquis closed 7 months ago

SimonMarquis commented 9 months ago

👋 Hi, the project is currently configured with these versions

I understand the complexity of updating these core components and why they are pinned. HTML markup is not documented as public API, and this might break things (#66). That being said, we are currently missing a lot of nice features and bugfixes.

What would be the best approach to update these dependencies? Are there any automated regression tests, or specific issues to check. Or does testing-dependencies-end-to-end is enough?

jcarres-mdsol commented 9 months ago

I am not maintainer here but I think upgrading to the latest 9.1.x material at least should be straightforward. material 9.2 mentions Updated MkDocs to 1.5.2 so maybe we can't move to that version while been on such an old mkdocs version. I can't talk about mkdocs, the changelog looks scary for 1.4 and 1.5

darrenyung commented 8 months ago

Apologies but I second this need for updates. New updates has been introduced post-material-mkdocs v9.2 particularly the built-in Blog that is highly sought after by teams within my org.

webark commented 8 months ago

What does the scope of an update look like? I haven't looked at it and don't have a ton of familiarness with it, but someone I work with does. Any new features?

alexlorenzi commented 7 months ago

Hi - We've just merged a change that bumps the version of mkdocs-material to 9.2.7. This did require us to up the lower bound of MkDocs to 1.5 which we were able to do, moving mkdocs-material to any higher version would have resulted in us needing to change the python version dependency, which is too large a change for right now.

The new version of mkdocs-techdocs-core is 1.3

SimonMarquis commented 7 months ago

While this update is very appreciated, it does not really solve the issue exposed here. Can we keep this issue open?

SimonMarquis commented 2 months ago

@alexlorenzi, this is happening once again with:

See also: