search

backstage / mkdocs-monorepo-plugin

✚ Build multiple documentation folders in a single Mkdocs. Designed for large codebases.
https://backstage.github.io/mkdocs-monorepo-plugin/
Apache License 2.0
314 stars 75 forks source link

Allows .yaml extension support #59

Closed diegomarangoni closed 2 years ago

diegomarangoni commented 2 years ago

Currently using mkdocs.yaml is not supported, it must have the extension .yml. This PR removes this limitation.

camilaibs commented 2 years ago

Looks great, only one thing, can you take a look at the failed pipeline checks, please?

diegomarangoni commented 2 years ago

It's failing because the new mkdocs version does not support python 3.5 how should I proceed?

camilaibs commented 2 years ago

It's failing because the new mkdocs version does not support python 3.5 how should I proceed?

You can use version 1.2.2

diegomarangoni commented 2 years ago

It's failing because the new mkdocs version does not support python 3.5 how should I proceed?

You can use version 1.2.2

It also requires python >= 3.6

camilaibs commented 2 years ago

It's failing because the new mkdocs version does not support python 3.5 how should I proceed?

You can use version 1.2.2

It also requires python >= 3.6

Just for more context, I'd like to involve @emmaindal or maybe @OrkoHunter in this topic. Do you know why we have these version list and would like to hear from you if we lose support for python 3.5 in favor of these changes or any other recommendations to resolve this issue?

camilaibs commented 2 years ago

It's failing because the new mkdocs version does not support python 3.5 how should I proceed?

You can use version 1.2.2

It also requires python >= 3.6

Just for more context, I'd like to involve @emmaindal or maybe @OrkoHunter in this topic. Do you know why we have these version list and would like to hear from you if we lose support for python 3.5 in favor of these changes or any other recommendations to resolve this issue?

Hello @diegomarangoni, we've talked internally, and it's okay to remove pyhton 3.5 from this list since that 3.5 is deprecated and everything continues to work as expected, so you can go ahead and remove 🙂

Thanks, @emmaindal for discussing this internally 🙌🏻

diegomarangoni commented 2 years ago

Nice! should I do it in a separate PR? or here is fine?

camilaibs commented 2 years ago

Nice! should I do it in a separate PR? or here is fine?

Here, to keep the context of why we did it. Thank you again!

iamEAP commented 2 years ago

Just to follow-up on this @diegomarangoni: we're good with merging this once you get to removing 3.5 from the supported python versions (I think a README.md update + an update to the GitHub workflow version matrix oughtta do it).

diegomarangoni commented 2 years ago

hi @camilaibs, @iamEAP, I dropped support for python 3.5, however, I can't remove the required github check should work now :)

iamEAP commented 2 years ago

Thanks again @diegomarangoni!