search

event-catalog / eventcatalog

An open source documentation tool to bring discoverability to your event-driven architectures
https://eventcatalog.dev
MIT License
1.81k stars 152 forks source link

Nested resources in v2? #771

Closed floriankraemer closed 1 month ago

floriankraemer commented 2 months ago

I've read the migration page and it says:

Resources require a flat structure In EventCatalog v1 you could nest your resources for example have your events or services within your domains folder. (Example /domains/services/MyService/index.md)

This feature is not currently supported in version 2.

Version 2 requires your domains, services and messages (commands, and events) to be in the root directory.

The key here is this:

is not currently supported

Does that mean you plan to support it any time soon? If yes we will wait for it with the migration.

carlosallexandre commented 2 months ago

@floriankraemer This is indeed planned. There are some adjustments in progress to be made to fully support this.

floriankraemer commented 2 months ago

Awesome! Is there any timeline known when this will be ready?

boyney123 commented 2 months ago

Thanks @carlosallexandre , yeah hopefully end of September for this one! Maybe sooner if I can get round to it. Most of its done on a branch, but I need to update plugins and SDK

boyney123 commented 2 months ago

For context , convo https://discord.com/channels/918092420338569216/1281539006936649803

floriankraemer commented 2 months ago

Awesome, thank you @boyney123. Is there any way to make a donation? I'll ask my company if they are willing to make a donation or donate something myself.

boyney123 commented 2 months ago

Awesome, thank you @boyney123. Is there any way to make a donation? I'll ask my company if they are willing to make a donation or donate something myself.

Sounds great! I'm actually waiting for GitHub to review my application to open sponsors for EventCatalog itself. I just pinged them as its been 2/3 weeks and still pending. Once it's done will share the link :)

boyney123 commented 2 months ago

GitHub reviewed the issue! Now live. https://github.com/sponsors/event-catalog

floriankraemer commented 2 months ago

@boyney123 are any news on this feature request, please?

boyney123 commented 2 months ago

Hey @floriankraemer on the backlog, just focusing on a new plugin at the moment, and then will take a look at this

boyney123 commented 1 month ago

Working on this at the moment, should be coming very soon @floriankraemer https://github.com/event-catalog/eventcatalog/pull/888

boyney123 commented 1 month ago

Ok this is live in 2.9.1 @floriankraemer , you can find some docs here https://www.eventcatalog.dev/docs/development/guides/project-structure#nested-resources-recommended

Let us know if you have any problems

floriankraemer commented 1 month ago

Awesome, thank you very much @boyney123! I'll review it on Monday at work.