Skip to content

Commit 00b8587

Browse files
jimisolaJimisola Laursen
jimisola
and
Jimisola Laursen
authored
docs: documentation overhaul (#147)
* docs: documentation overhaul - Standardize README.md with consistent badges and structure - Add CONTRIBUTING.md with repo-specific dev setup - Add/update Antora docs structure - Remove per-repo GitHub Pages workflow - Point documentation badge to central site Signed-off-by: jimisola <jimisola@jimisola.com> * docs: rewrite plugin docs using Gradle template structure - Add features list, quick start, minimal setup, prerequisites - Improve configuration with inline comments and better descriptions - Add manual invocation, annotation dependency, lifecycle docs - Convert markdown fenced blocks to AsciiDoc source blocks - Remove project/log params (Maven internal, not user-facing) - Simplify license page Signed-off-by: jimisola <jimisola@jimisola.com> * docs: streamline nav and page structure - Separate nav items instead of single include-based page - Merge description.adoc content into index.adoc - Remove license.adoc, add inline license to index.adoc - Change nav label from Start to Overview Signed-off-by: jimisola <jimisola@jimisola.com> * docs: fix Java prerequisite 17 → 8 (matches maven.compiler.source) Signed-off-by: jimisola <jimisola@jimisola.com> * docs: use lowercase reqstool consistently Signed-off-by: jimisola <jimisola@jimisola.com> * docs: update Java prerequisite from 8+ to 21+ Signed-off-by: jimisola <jimisola@jimisola.com> --------- Signed-off-by: jimisola <jimisola@jimisola.com> Co-authored-by: Jimisola Laursen <jimisola.laursen@resurs.se>
1 parent aa62b90 commit 00b8587

11 files changed

Lines changed: 295 additions & 223 deletions

File tree

‎.github/workflows/publish_gh_pages.yml‎

Lines changed: 0 additions & 47 deletions
This file was deleted.

‎CONTRIBUTING.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing to reqstool-java-maven-plugin
2+
3+
Thank you for your interest in contributing!
4+
5+
For DCO sign-off, commit conventions, and code review process, see the organization-wide [CONTRIBUTING.md](https://github.com/reqstool/.github/blob/main/CONTRIBUTING.md).
6+
7+
## Prerequisites
8+
9+
- Java 21+
10+
- Maven 3.9+
11+
12+
## Setup
13+
14+
```bash
15+
git clone https://github.com/reqstool/reqstool-java-maven-plugin.git
16+
cd reqstool-java-maven-plugin
17+
```
18+
19+
## Build & Test
20+
21+
```bash
22+
mvn verify
23+
```

‎README.adoc‎

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎README.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
[![Commit Activity](https://img.shields.io/github/commit-activity/m/reqstool/reqstool-java-maven-plugin?label=commits&style=for-the-badge)](https://github.com/reqstool/reqstool-java-maven-plugin/pulse)
2+
[![GitHub Issues](https://img.shields.io/github/issues/reqstool/reqstool-java-maven-plugin?style=for-the-badge&logo=github)](https://github.com/reqstool/reqstool-java-maven-plugin/issues)
3+
[![License](https://img.shields.io/github/license/reqstool/reqstool-java-maven-plugin?style=for-the-badge&logo=opensourceinitiative)](https://opensource.org/license/mit/)
4+
[![Build](https://img.shields.io/github/actions/workflow/status/reqstool/reqstool-java-maven-plugin/build.yml?style=for-the-badge&logo=github)](https://github.com/reqstool/reqstool-java-maven-plugin/actions/workflows/build.yml)
5+
[![Documentation](https://img.shields.io/badge/Documentation-blue?style=for-the-badge&link=docs)](https://reqstool.github.io)
6+
7+
# Reqstool Maven Plugin
8+
9+
Maven build plugin for [reqstool](https://github.com/reqstool/reqstool-client) that assembles requirements traceability artifacts.
10+
11+
## Overview
12+
13+
Collects `@Requirements` and `@SVCs` annotations from compiled Java code, combines them with test results, and packages everything into a ZIP artifact for analysis by the reqstool CLI.
14+
15+
## Installation
16+
17+
Add the plugin to your `pom.xml`:
18+
19+
```xml
20+
<plugin>
21+
<groupId>io.github.reqstool</groupId>
22+
<artifactId>reqstool-maven-plugin</artifactId>
23+
<version>1.0.4</version>
24+
<executions>
25+
<execution>
26+
<goals>
27+
<goal>assemble-and-attach-zip-artifact</goal>
28+
</goals>
29+
</execution>
30+
</executions>
31+
<configuration>
32+
<datasetPath>${project.basedir}/docs/reqstool</datasetPath>
33+
</configuration>
34+
</plugin>
35+
```
36+
37+
## Usage
38+
39+
```bash
40+
mvn clean verify
41+
```
42+
43+
The plugin generates a ZIP artifact in `target/reqstool/` containing requirements, annotations, and test results.
44+
45+
## Documentation
46+
47+
Full documentation can be found [here](https://reqstool.github.io).
48+
49+
## Contributing
50+
51+
See the organization-wide [CONTRIBUTING.md](https://github.com/reqstool/.github/blob/main/CONTRIBUTING.md).
52+
53+
## License
54+
55+
MIT License.

‎docs/antora-playbook.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# yaml-language-server: $schema=https://raw.githubusercontent.com/asciidoctor/asciidoctor-intellij-plugin/main/src/main/resources/jsonSchemas/antoraPlaybookSchema.json
2+
# For local development only. Published site: https://reqstool.github.io
23

34
site:
45
title: Reqstool Maven Plugin

‎docs/modules/ROOT/nav.adoc‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
* xref:index.adoc[Start]
1+
* xref:index.adoc[Overview]
2+
* xref:configuration.adoc[Configuration]
3+
* xref:usage.adoc[Usage]

0 commit comments

Comments
 (0)