jqassistant-tutorials/jqassistant-101

Collection of small tutorials on jQAssistant

jqassistant-101's Issues

We need a short introduction on Asciidoctor

Bevore we give an introduction on writing rules with the help of Asciidoctor we should give the user a short introduction on Asciidoctor.

Top level Readme mit Übersicht über alle Tutorials erstellen

Add a readme to the project

The readme should

• explain what jqassistant-101 is
• provide a link to ower twitter account
• contain the rules for contributions

Tutorial - Sharing Rules Between Projects

Update DDD 101 to 1.8.0

Tutorial - Getting started with jQA, Spring Boot and Maven

Find a license for 101

What licence should be used for 101?

Tutorial - Documenting and Securing architecture decisions with ADRs and jQAssistant

• neuer AsciiDoc Mechanismus
• Regeln in XML verschieben

Tutorial - Generate Reports About Structures and Metrics

• Report Types
• Metriken entfernen

Jedes Tutorial in eigenen Ordner

Upgrade auf jQA 2 + .jqassistant.yml
Update auf aktuelle jQA Plugins

We need an simple tutorial how to write own rules in XML

See title.

We need a Maven multi module project tutorial

See title.

We need a short introduction on writing rules with the help of Asciidoctor

See title.

Tutorial - Implementation Of A Scanner Plugin

migration guide improvements

A few things I missed while using the 1.x-2.0 migration guide:

• I noticed I can use maven variables like ${version} in the yml. That's pretty neat and worth a mention
• If not in this guide then at some other prominent place you should spend a few words on why you dropped support for rules in AsciiDoc. It had me quite surprised. Eventhough I always had my rules in xml, I enjoyed printing the results into an AsciiDoc.
• Glad you added the hint about the additional MAVEN_OPTS. I have no clue though on why these are needed. Some context would benefit the understanding

Tutorial - Getting started with jQAssistant and Domain Driven Design

Auf jMolecules umstellen

Enhancements for scanner plugin tutorial

• Rules for exception handling
• Starting a Neo4j Browser for manually inspecting generated graphs
• Guidelines
  • graph modelling (e.g. multiple labels, naming of labels and relationships)
  • for tests (e.g. unit vs. IT)
• Link to XO documentation instead of project homepage
• Plugin configuration
• Finding existing nodes/relations using indexed properties or queries
• Caching of nodes vs. database lookups
• Work with scopes

Usage with Gradle

@jensnerche has provided an introduction for using jQA with Gradle and invited us to use it as starting point for a tutorial, see https://twitter.com/jensnerche/status/957264311151480832.

Create Migration Guide for jQA 2.0

• Topics
  • configuration for CLI and Maven
  • updated/deleted rules
  • plugins removed from core distribution
  • new organizations (plugin, archive, tooling)
  • tutorials merged with examples
  • update to Java 11, Neo4j 4.x (note about usage w/ Java 17)

Proposed Structure:

• General
  • Java 11, Neo4j
  • new GitHub organization structure
• Migrations
  • General remarks (mainly configuration)
    • link to reference doc, explanation for reuse-store in Maven plugin
  • Explicit declaration of plugins formerly provided by core distribution
  • Maven
    • including inherited parent configs (yaml in parent pom)
  • CLI
  • new/updated/deleted rules
    • mainly java dependencies

Tutorial on using YAML als document format for rules

We need an tutorial on using YAML as document format for rules. YAML based documents for rules are requeted via jQAssistant/jqa-core-framework#25

Provide navigation from tutorial back to index page

Each tutorial should provide an easy way to navigate back to the tutorial overview page.

We need a tutorial on the basic usage for the commandline usage of jQAssistant

See title.