after version 1.0.0, mkdocs with this plugin exits on a TypeError about mkdocs-monorepo-plugin HOT 4 CLOSED

More information:
The error occurs when a module starts with a site name with a '/' in it

site_name: org/module1

Seems to be problematic

from mkdocs-monorepo-plugin.

Update: changing line 35 in edit_uri.py to

alias = "/".join(parts)

fixes the issue (which seemed to already have been fixed in version 0.4.9)

So using / instead of the os specific os.path solves the problem... I don't know if you'd consider this a structural fix though 🤷‍♂️

from mkdocs-monorepo-plugin.

@timconinx Is the name of the component org/module? Is that also the name in the software catalog? The catalog doesn't support / in the name (https://backstage.io/docs/features/software-catalog/descriptor-format#name-required) so I'd be hesitant to say that techdocs supports slashes.

I'd recommend just using the allowed characters -_.. Is that a viable option for you?

from mkdocs-monorepo-plugin.

Thank you for your answer. We changed the site-name's to include underscores instead of slashes. And we'll make a note not to include slashes in future sitenames.

from mkdocs-monorepo-plugin.