Updated README.md.

faisalazam · Jun 22, 2023 · 342fcc1 · 342fcc1
1 parent 2d46c24
commit 342fcc1
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -1,23 +1,24 @@
-[![Parent CI/CD](https://github.com/faisalazam/MavenInActionWithGitHubActions/actions/workflows/parent-build.yml/badge.svg)](https://github.com/faisalazam/MavenInActionWithGitHubActions/actions/workflows/parent-build.yml)
-[![pages-build-deployment](https://github.com/faisalazam/MavenInActionWithGitHubActions/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/faisalazam/MavenInActionWithGitHubActions/actions/workflows/pages/pages-build-deployment)
-[![Instructions Coverage](https://faisalazam.github.io/MavenInActionWithGitHubActions/INDIVIDUAL_MODULES/PuttingAllTogether/jacoco-merged/jacoco-resources/badges/jacoco.svg)](https://faisalazam.github.io/MavenInActionWithGitHubActions/INDIVIDUAL_MODULES/PuttingAllTogether/jacoco-merged/index.html)
-[![Branches Coverage](https://faisalazam.github.io/MavenInActionWithGitHubActions/INDIVIDUAL_MODULES/PuttingAllTogether/jacoco-merged/jacoco-resources/badges/branches.svg)](https://faisalazam.github.io/MavenInActionWithGitHubActions/INDIVIDUAL_MODULES/PuttingAllTogether/jacoco-merged/index.html)
-[![checkstyle](https://faisalazam.github.io/MavenInActionWithGitHubActions/INDIVIDUAL_MODULES/PuttingAllTogether/badges/checkstyle-result.svg)](https://faisalazam.github.io/MavenInActionWithGitHubActions/INDIVIDUAL_MODULES/PuttingAllTogether/checkstyle.html)
-![Known Vulnerabilities](https://snyk.io/test/github/faisalazam/maveninactionwithgithubactions/badge.svg)
-[![Apache License, Version 2.0, January 2004](https://img.shields.io/github/license/apache/maven.svg?label=License)](https://faisalazam.github.io/MavenInActionWithGitHubActions/LICENSE)
+[![Parent CI/CD][parent-cicd-badge-url]][parent-cicd-link-url]
+[![pages-build-deployment][pages-build-deployment-badge-url]][pages-build-deployment-link-url]
+[![Instructions Coverage][instructions-coverage-badge-url]][instructions-coverage-link-url]
+[![Branches Coverage][branches-coverage-badge-url]][branches-coverage-link-url]
+[![checkstyle][checkstyle-badge-url]][checkstyle-link-url]
+![Known Vulnerabilities][known-vulnerabilities-badge-url]
+[![Apache License, Version 2.0, January 2004][apache-license-badge-url]][apache-license-link-url]
+
 
 <h1 style="text-align:center">
   Maven, Plugins, GitHub Pages, and GitHub Workflows/Actions
 </h1>
 
 <p>
-    <a href="https://faisalazam.github.io/MavenInActionWithGitHubActions/staging/index.html">This project</a> 
+    <a href="https://faisalazam.github.io/MavenInActionWithGitHubActions">This project</a> 
     will automatically be deployed to <a href="https://pages.github.com/">GitHub Pages</a> 
     with <a href="https://github.com/features/actions">GitHub Actions</a> by going through the following steps:
 </p>
 <p>
     <a href="https://github.com/faisalazam/MavenInActionWithGitHubActions/actions/workflows/putting-all-together.yml">
-        <img src="https://github.com/faisalazam/MavenInActionWithGitHubActions/tree/master/.github/assets/putting-all-together.png" alt="" />
+        <img src="https://github.com/faisalazam/MavenInActionWithGitHubActions/raw/master/.github/assets/putting-all-together.png" alt="" />
     </a>
 </p>
 
@@ -39,18 +40,36 @@
 </ul>
 
 ## Modules
-<p>
-    Following are the sub-modules of this [parent project][parent-project-url]:
-</p>
+Following are the sub-modules of this [parent project][parent-project-url]:
+
+| Module                                         | Status                                                                                                                                                                                      |
+|------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [SiteGeneration][site-generation-url]          | [![Site CI/CD][site-cicd-badge-url]][site-cicd-link-url] [![pages-build-deployment][pages-build-deployment-badge-url]][pages-build-deployment-link-url]                                     |
+| [TestsExecution][tests-execution-url]          |                                                                                                                                                                                             |
+| [JacocoExecution][jacoco-execution-url]        |                                                                                                                                                                                             |
+| [PuttingAllTogether][putting-all-together-url] | [![PuttingAllTogether CI/CD][putting-all-together-badge-url]][putting-all-together-link-url] [![pages-build-deployment][pages-build-deployment-badge-url]][pages-build-deployment-link-url] |
 
-* [SiteGeneration][site-generation-url]
-* [TestsExecution][tests-execution-url]
-* [JacocoExecution][jacoco-execution-url]
-* [PuttingAllTogether][putting-all-together-url]
 
 
 <!-- MARKDOWN LINKS & IMAGES -->
 <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[parent-cicd-badge-url]:https://github.com/faisalazam/MavenInActionWithGitHubActions/actions/workflows/parent-build.yml/badge.svg
+[parent-cicd-link-url]:https://github.com/faisalazam/MavenInActionWithGitHubActions/actions/workflows/parent-build.yml
+[pages-build-deployment-badge-url]:https://github.com/faisalazam/MavenInActionWithGitHubActions/actions/workflows/pages/pages-build-deployment/badge.svg
+[pages-build-deployment-link-url]:https://github.com/faisalazam/MavenInActionWithGitHubActions/actions/workflows/pages/pages-build-deployment
+[instructions-coverage-badge-url]:https://faisalazam.github.io/MavenInActionWithGitHubActions/INDIVIDUAL_MODULES/PuttingAllTogether/jacoco-merged/jacoco-resources/badges/jacoco.svg
+[instructions-coverage-link-url]:https://faisalazam.github.io/MavenInActionWithGitHubActions/INDIVIDUAL_MODULES/PuttingAllTogether/jacoco-merged/index.html
+[branches-coverage-badge-url]:https://faisalazam.github.io/MavenInActionWithGitHubActions/INDIVIDUAL_MODULES/PuttingAllTogether/jacoco-merged/jacoco-resources/badges/branches.svg
+[branches-coverage-link-url]:https://faisalazam.github.io/MavenInActionWithGitHubActions/INDIVIDUAL_MODULES/PuttingAllTogether/jacoco-merged/index.html
+[checkstyle-badge-url]:https://faisalazam.github.io/MavenInActionWithGitHubActions/INDIVIDUAL_MODULES/PuttingAllTogether/badges/checkstyle-result.svg
+[checkstyle-link-url]:https://faisalazam.github.io/MavenInActionWithGitHubActions/INDIVIDUAL_MODULES/PuttingAllTogether/checkstyle.html
+[known-vulnerabilities-badge-url]:https://snyk.io/test/github/faisalazam/maveninactionwithgithubactions/badge.svg
+[apache-license-badge-url]:https://img.shields.io/github/license/apache/maven.svg?label=License
+[apache-license-link-url]:https://faisalazam.github.io/MavenInActionWithGitHubActions/staging/licenses.html
+[site-cicd-badge-url]:https://github.com/faisalazam/MavenInActionWithGitHubActions/actions/workflows/site-generation.yml/badge.svg
+[site-cicd-link-url]:https://github.com/faisalazam/MavenInActionWithGitHubActions/actions/workflows/site-generation.yml
+[putting-all-together-badge-url]:https://github.com/faisalazam/MavenInActionWithGitHubActions/actions/workflows/putting-all-together.yml/badge.svg
+[putting-all-together-link-url]:https://github.com/faisalazam/MavenInActionWithGitHubActions/actions/workflows/putting-all-together.yml
 [parent-project-url]:https://faisalazam.github.io/MavenInActionWithGitHubActions/staging/index.html
 [site-generation-url]:https://faisalazam.github.io/MavenInActionWithGitHubActions/staging/SiteGeneration/sitegeneration/index.html
 [tests-execution-url]:https://faisalazam.github.io/MavenInActionWithGitHubActions/staging/TestsExecution/testsexecution/index.html

diff --git a/SiteGeneration/README.md b/SiteGeneration/README.md
@@ -1,3 +1,14 @@
+<!-- TOC -->
+  * [Maven Site In Action](#maven-site-in-action)
+  * [Generating the Project Site](#generating-the-project-site)
+  * [Plugins to use](#plugins-to-use)
+  * [Configuring the project site](#configuring-the-project-site)
+  * [Setting custom css or javascript site descriptor file](#setting-custom-css-or-javascript-site-descriptor-file)
+  * [Copying the README.md file](#copying-the-readmemd-file)
+  * [Generating the Project Site for multimodule project](#generating-the-project-site-for-multimodule-project)
+  * [Configuring Reports](#configuring-reports)
+<!-- TOC -->
+
 ## Maven Site In Action
 
 The purpose of this small project is to utilize the [maven's site][maven-site-plugin-url] plugin to generate the project reports.

diff --git a/TestsExecution/README.md b/TestsExecution/README.md
@@ -1,3 +1,16 @@
+<!-- TOC -->
+  * [Testing in action with Maven](#testing-in-action-with-maven)
+  * [Plugin Configurations](#plugin-configurations)
+  * [Maven profiles](#maven-profiles)
+  * [Conventions](#conventions)
+  * [Running the tests](#running-the-tests)
+  * [Running a single test](#running-a-single-test)
+  * [Configure test reporting](#configure-test-reporting)
+      * [Using the `reportSets` Tag](#using-the-reportsets-tag)
+  * [Binding the goals and phases to achieve something different](#binding-the-goals-and-phases-to-achieve-something-different)
+  * [Read further if you want to set custom paths for tests' results](#read-further-if-you-want-to-set-custom-paths-for-tests-results)
+<!-- TOC -->
+
 ## Testing in action with Maven
 
 The purpose of this small project is to utilize the maven's [surefire][surefire-url], [failsafe][failsafe-url],
@@ -42,7 +55,7 @@ Learn more about [Configuring plugins][configuring-plugins-url]
     * Configured profiles (in [pom.xml](pom.xml) file) are:
 
       | Profile ID | Profile Description                                          |
-          |------------|--------------------------------------------------------------|
+      |------------|--------------------------------------------------------------|
       | `ut`       | It'll run only the unit tests                                |
       | `it`       | It'll run only the integration tests                         |
       | `uit`      | It'll run both the unit and the integration tests            |