For convenience reasons the repositories are aggregated as sub-modules in this Git repository. You can clone it using git clone --recursive https://github.com/jQAssistant/jQAssistant.git. Once checked out you might need to run git submodule update --remote to update to the latest commits of the sub-modules.
Since the documentation does not yet seem to be available anywhere online, I was trying to build it locally.
I checked out the REL-2.0.0 tag and tried building using Java 11 since that is the minimum version required by the enforcer plugin configuration. However, I get this failure message:
[ERROR] Failed to execute goal com.buschmais.jqassistant:jqassistant-maven-plugin:1.12.2:scan (default) on project manual: Execution default of goal com.buschmais.jqassistant:jqassistant-maven-plugin:1.12.2:scan failed: Error starting org.neo4j.graphdb.facade.GraphDatabaseFacadeFactory, /.../git/jqa-manual/target/jqassistant: Component 'org.neo4j.kernel.NeoStoreDataSource@3d1b13a' was successfully initialized, but failed to start. Please see the attached cause exception "Unable to make field private java.lang.String java.lang.Throwable.detailMessage accessible: module java.base does not "opens java.lang" to unnamed module @1024b871". Could not get Throwable message field -> [Help 1]
Out user @hwellmann reported that since version 1.5.0 the documentation of the jQA Spring Plugin is not properly included and rendered in the jQA manual.
I can confirm this also for the current development version. I suppose this is a subtle bug in the XSLT scripts we use.
We would like to provide a better documentation to the users of jQAssistant. Therefore we decided to write a new user guide and an additional reference manual.
Therefore we need to setup the basic structure for both documents parallel to the existing documents.
As core developer of jQAssistant, I want this project to be build on various plattforms with different JDK versions on each commit, so that I know if the change done my the commit does not break the build and the software is fully functional.
The following acceptance criterias must be met:
mvn -DskipTests -Djqassistant.skip clean install must pass
mvn -Djqassistant.skip clean install must pass
mvn -P IT clean install must pass
mvn -DskipTests -Djqassistant.skip=false clean install must pass
As a maintainer of jQAssistant, I would like the documentation to document, that all schemas for rule documents (JSON and XML) are online available, so that a user of jQAssistant can download or configure them in his editor or IDE.
jQAssitant supports rule parameters. How to use them correctly is not documented in the user manual of jQAssistant. Missing documentation should be added for the next release.
The Rules section of the manual explains what a concept and a rule is. The examples given in these sections are very minimal. Therefore it is difficult for readers to get the difference between both.
It would help to improve the comprehensibleness of these sections if the example there full Cypher queries. Futhermore the text in these sections should refer to the given examples.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent