Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Enhancement request] integration between the docs generated by spring-modulith-docs and maven site #1048

Open
patpatpat123 opened this issue Feb 4, 2025 · 1 comment
Labels
in: documentation support Documentation generation meta: contributions welcome Good for newcomers type: enhancement Major enhanvements, new features

Comments

@patpatpat123
Copy link

Hello team, hello Oliver,

This is my first ticket in this repo.
If not anything else, just wanted to say thanks for this project.
It is useful, interesting and brings a nice addition to Spring.

Just wanted to reach out with a small enhancement request.
The modulith docs are very cool, both the plant uml and the ascii ones.

Like many java springboot projects, we use maven.
Maven offers a goal called site, which builds a website.
This is what ours looks like, but there are many fancier, cooler, more beautiful, with more internal pages, etc...

Image

As of now, we built a custom script after running the generated unit tests, to copy and export out all the plant uml files.
This is so we can further distribute the docs to relevant teams, put them inside other websites etc.

It would be a great enhancement and benefit the community if the docs could be integrated directly into the maven pages, where usually teams are used generating it are used to go there.

Thank you for your time.

@odrotbohm odrotbohm added in: documentation support Documentation generation type: enhancement Major enhanvements, new features meta: contributions welcome Good for newcomers labels Feb 7, 2025
@odrotbohm
Copy link
Member

I guess I am too much of a Maven noob to have an idea how to integrate with Maven's site mechanism, but I'd happily accept a contribution, even if it just lays out the fundamental setup.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: documentation support Documentation generation meta: contributions welcome Good for newcomers type: enhancement Major enhanvements, new features
Projects
None yet
Development

No branches or pull requests

2 participants