Skip to content

WP1 – Migrate module documentation into the module repositories #3

Open

Description

@marcphilipp

Move the documentation of each module out of the central assertj/doc repository into the repository of that module, and convert the single Asciidoctor page into Antora pages.

  • Split the single-page user guide along its existing files (quick start, assertions guide, extensions, migration, …) into one Antora component per module, one page per file, with xrefs instead of in-page links. Keep the section IDs unchanged.
  • Move the documentation (including historical release notes) of AssertJ Core and AssertJ Guava into assertj/assertj and AssertJ DB into assertj/assertj-db.
  • Move the code samples into the test sources of each module, so that the module's build compiles them and a breaking change fails the same pull request.
  • Generate each component's version from the Maven project version, so that every future release tag produces a versioned copy of the documentation without manual steps.
  • Remove the documentation of AssertJ Neo4j as it's unmaintained.
  • Set up the Antora Maven plugin to support previewing the documentation.
  • Keep the documentation of AssertJ Joda-Time and AssertJ Swing as unversioned components in the site repository: the Joda-Time repository is inactive, and the Swing documentation consists only of release notes.
  • Document for contributors where documentation lives and how to preview it.
  • Create an antora/<version> branch for the latest stable version in each repository.

Deliverable: pull requests to assertj/assertj, assertj/assertj-db and assertj/docs.assertj.dev.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions