Skip to content

Create PlantUML diagramms for Maven sources page #615

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Dec 30, 2024
+561 −28
Merged

Create PlantUML diagramms for Maven sources page #615

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7520d38
Use puml to generate sources diagrams
slawekjaranowski Dec 31, 2023
5b0e83b
Next step
slawekjaranowski Jan 5, 2024
f16a290
Create PlantUML diagramms for Maven sources page.
Bukama Dec 29, 2024
36f7023
Create PlantUML diagramms for Maven sources page.
Bukama Dec 29, 2024
fecf690
Maarten's feedback
Bukama Dec 29, 2024
2e2bcb0
Correcting Ant Task URL
Bukama Dec 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed content/xdoc/maven-sources.odg
View file
Open in desktop
Binary file not shown.
48 changes: 20 additions & 28 deletions content/xdoc/scm.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,34 +64,26 @@ repo start master --all</pre>
</subsection>

<subsection name="Maven Sources Overview">
<p align="center">
<img src="maven-sources.png" width="843" height="837" border="0" usemap="#maven-sources" />
<map name="maven-sources">
<area shape="rect" coords="8,1,82,36" alt="Site" href="https://github.com/apache/maven-site" />
<area shape="rect" coords="100,0,205,37" alt="Sources" href="https://github.com/apache/maven-sources/" />
<area shape="rect" coords="89,43,171,78" alt="Maven" href="/ref/current" />
<area shape="rect" coords="178,43,275,78" alt="Core ITs" href="/core-its" />
<area shape="rect" coords="283,43,387,78" alt="Resolver" href="/resolver" />
<area shape="rect" coords="393,43,497,78" alt="Ant Tasks" href="/resolver-ant-tasks" />
<area shape="rect" coords="1,89,842,424" alt="Plugins" href="/plugins" />
<area shape="rect" coords="80,432,163,466" alt="Doxia" href="/doxia/doxia" />
<area shape="rect" coords="169,432,278,467" alt="Site Tools" href="/doxia/doxia-site-tools" />
<area shape="rect" coords="283,432,359,466" alt="Site" href="/doxia" />
<area shape="rect" coords="445,431,549,466" alt="Converter" href="/doxia/doxia-tools/doxia-converter" />
<area shape="rect" coords="554,431,659,466" alt="Linkcheck" href="/doxia/doxia-tools/doxia-linkcheck" />
<area shape="rect" coords="69,473,191,508" alt="Archetypes" href="/archetypes" />
<area shape="rect" coords="198,473,272,508" alt="Poms" href="/pom" />
<area shape="rect" coords="280,473,355,508" alt="Skins" href="/skins" />
<area shape="rect" coords="392,472,468,507" alt="Studies" href="/studies" />
<area shape="rect" coords="502,473,597,508" alt="Indexer" href="/maven-indexer" />
<area shape="rect" coords="604,473,699,509" alt="Wagon" href="/wagon" />
<area shape="rect" coords="705,473,836,509" alt="Plugin testing" href="/plugin-testing" />
<area shape="rect" coords="69,515,164,551" alt="dist tool" href="https://builds.apache.org/job/dist-tool-plugin/site/index.html" />
<area shape="rect" coords="280,514,354,550" alt="env" href="https://github.com/apache/maven-jenkins-env" />
<area shape="rect" coords="360,515,435,550" alt="lib" href="https://github.com/apache/maven-jenkins-lib" />
<area shape="rect" coords="1,557,833,779" alt="shared" href="/shared" />
<area shape="rect" coords="1,787,560,836" alt="Plexus" href="https://codehaus-plexus.github.io/" />
</map>
<p>
<object type="image/svg+xml" data="maven-sources/site.svg"/>
</p>
<p>
<object type="image/svg+xml" data="maven-sources/core.svg"/>
</p>
<p>
<object type="image/svg+xml" data="maven-sources/plugins.svg"/>
</p>
<p>
<object type="image/svg+xml" data="maven-sources/doxia.svg"/>
</p>
<p>
<object type="image/svg+xml" data="maven-sources/misc.svg"/>
</p>
<p>
<object type="image/svg+xml" data="maven-sources/shared.svg"/>
</p>
<p>
<object type="image/svg+xml" data="maven-sources/plexus.svg"/>
</p>
<p>Each component has its own Jira project or component for issue tracking:
see the <a href="/issue-management.html">Issue Management report</a> to get a summary.
Expand Down
46 changes: 46 additions & 0 deletions src/plantuml/maven-sources/core.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/
@startuml
!pragma layout smetana

<style>
rectangle {
BackgroundColor LightBlue
}
}
</style>

package "Maven Core" {
rectangle Maven
rectangle "Core ITs"
rectangle Resolver
rectangle "Ant Tasks"
}

'hidden dependencies to change layout
Maven -[hidden]right-> "Core ITs"
"Core ITs" -[hidden]right-> Resolver
Resolver -[hidden]right-> "Ant Tasks"

url of Maven is [[https://github.com/apache/maven]]
url of "Core ITs" is [[https://github.com/apache/maven-integration-testing]]
url of Resolver is [[https://github.com/apache/maven-resolver]]
url of "Ant Tasks" is [[https://github.com/apache/maven-resolver-ant-tasks]]

@enduml
50 changes: 50 additions & 0 deletions src/plantuml/maven-sources/doxia.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/
@startuml
!pragma layout smetana

<style>
rectangle {
BackgroundColor LightBlue
}
}
</style>

package "Maven Doxia" {
rectangle Doxia
rectangle "Site Tools"
rectangle Site #LightGrey
package Tools {
rectangle Converter
rectangle LinkCheck
}
}

'hidden dependencies to change layout
Doxia -[hidden]right-> "Site Tools"
"Site Tools" -[hidden]right-> Site
"Site Tools" -[hidden]right-> Tools

url of Doxia is [[https://github.com/apache/maven-doxia]]
url of "Site Tools" is [[https://github.com/apache/maven-doxia-sitetools]]
url of Site is [[https://github.com/apache/maven-doxia-site]]
url of Converter is [[https://github.com/apache/maven-doxia-converter]]
url of LinkCheck is [[https://github.com/apache/maven-doxia-linkcheck]]

@enduml
66 changes: 66 additions & 0 deletions src/plantuml/maven-sources/misc.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
/*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/
@startuml
!pragma layout smetana

<style>
rectangle {
BackgroundColor LightBlue
}
}
</style>

package Misc {
rectangle Archetypes
rectangle Poms
rectangle Skins
rectangle Studies
rectangle Indexer
rectangle Wagon
rectangle "Plugin testing"
rectangle "Distribution Tool Plugin"
package Jenkins {
rectangle Environment
rectangle "Shared Libraries"
}
}

'hidden dependencies to change layout
Archetypes -[hidden]right-> Poms
Poms -[hidden]right-> Skins
Skins -[hidden]right-> Studies
Studies -[hidden]right-> Indexer
Indexer -[hidden]right-> Wagon
Wagon -[hidden]right-> "Plugin testing"

Archetypes -[hidden]down-> "Distribution Tool Plugin"
"Distribution Tool Plugin" -[hidden]right-> Jenkins

url of "Archetypes" is [[https://github.com/apache/maven-archetype]]
url of Poms is [[https://github.com/apache/maven-parent]]
url of Skins is [[https://github.com/apache/maven-skins]]
url of Studies is [[https://github.com/apache/maven-studies]]
url of Indexer is [[https://github.com/apache/maven-indexer]]
url of Wagon is [[hhttps://github.com/apache/maven-wagon]]
url of "Plugin testing" is [[https://github.com/apache/maven-plugin-testing]]
url of "Distribution Tool Plugin" is [[https://github.com/apache/maven-dist-tool]]
url of Environment is [[https://github.com/apache/maven-jenkins-env]]
url of "Shared Libraries" is [[https://github.com/apache/maven-jenkins-lib]]

@enduml
43 changes: 43 additions & 0 deletions src/plantuml/maven-sources/plexus.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/
@startuml
!pragma layout smetana

<style>
rectangle {
BackgroundColor Yellow
}
}
</style>

package "Plexus" {
rectangle "Utils"
rectangle "Classworlds"
rectangle "Modello"
}

'hidden dependencies to change layout
"Utils" -[hidden]right-> "Classworlds"
"Classworlds" -[hidden]right-> "Modello"

url of "Utils" is [[https://github.com/codehaus-plexus/plexus-utils]]
url of "Classworlds" is [[https://github.com/codehaus-plexus/plexus-classworlds]]
url of "Modello" is [[https://github.com/codehaus-plexus/modello]]

@enduml
Loading