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

Bump mkdocs material to v9 #109

Closed agentbellnorm closed 1 year ago

agentbellnorm commented 1 year ago

mkdocs-material 9

This PR bumps mkdocs-material, and some of its dependencies, to their latest version.

💥 Impact?

I have suggested to release this as a minor version, reasoning that

Please check out the changelog for more details: https://github.com/backstage/mkdocs-techdocs-core/blob/60f5c4ed6446d7e02e5c0be87228801f87c273be/README.md?plain=1#L148-L157

🚂 PR Sequence

To distribute this change, there are a few PR:s that should be merged in the following order:

  1. @backstage/plugin-techdocs: https://github.com/backstage/backstage/pull/17031
  2. This PR: https://github.com/backstage/mkdocs-techdocs-core/pull/109
  3. spotify/techdocs docker image bump: https://github.com/backstage/techdocs-container/pull/48
  4. @backstage/techdocs-node: https://github.com/backstage/backstage/pull/17047

🔧 To consider when upgrading (once all PRs are merged)

To start using mkdocs-techdocs-core:1.2.0, these are the recommended steps

  1. Upgrade to version 1.13.0 (or nightly builds after 2023-03-24) of @backstage/plugin-techdocs in your backstage deployment
  2. Upgrade your image to spotify/techdocs:1.2
  3. Please let us know through gh issues or discord if you encounter any problems

Related issues: https://github.com/backstage/mkdocs-techdocs-core/issues/108, https://github.com/backstage/mkdocs-techdocs-core/issues/63

axdotl commented 1 year ago

Dear @backstage/techdocs-core, is there anything what prevents to get this merged soon?