spring-projects / spring-projects/spring-modulith

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

Open
#1,048 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

in: documentation support meta: contributions welcome type: enhancement
Dominant language
Java
Stars
1.2k
Forks
222
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the documentation generated by spring-modulith-docs and Maven's site goal, then compare the existing custom script that copies PlantUML files. Determine what integration into the Maven pages should include and how it should be configured; the issue is done when the generated modulith documentation is available through the Maven site without that script.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring-boot
Domain
build-system, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.