Add docs

- Use grace-doc to generate documentation

- Remove unused assets

Author: rainboyan

build.gradle

@@ -10,6 +10,7 @@ buildscript {
     }
     dependencies {
         classpath "io.github.gradle-nexus:publish-plugin:2.0.0"
+        classpath "org.graceframework:grace-gradle-plugin:$graceVersion"
         classpath "io.spring.gradle:dependency-management-plugin:$dependencyManagementPluginVersion"
     }
 }
@@ -22,11 +23,13 @@ ext.isReleaseVersion = !projectVersion.endsWith("SNAPSHOT")
 version = project.projectVersion
 group = "org.graceframework"
 
+apply plugin: "groovy"
 apply plugin: "java-library"
 apply plugin: "io.github.gradle-nexus.publish-plugin"
 apply plugin: "maven-publish"
 apply plugin: "signing"
 apply plugin: "idea"
+apply plugin: 'org.graceframework.grace-doc'
 
 allprojects {
     repositories {
@@ -37,16 +40,16 @@ allprojects {
             }
         }
     }
+
+    configurations {
+        documentation
+    }
 }
 
 subprojects {
     version = project.projectVersion
     group = "org.graceframework"
 
-    configurations {
-        documentation
-    }
-
     apply plugin: "groovy"
     apply plugin: "eclipse"
     apply plugin: "idea"
@@ -67,10 +70,6 @@ subprojects {
         }
     }
 
-    configurations {
-        documentation
-    }
-
     dependencies {
         api "org.apache.groovy:groovy"
         testImplementation "org.apache.groovy:groovy-test-junit5"
@@ -86,11 +85,6 @@ subprojects {
             runtimeOnly "org.junit.jupiter:junit-jupiter-engine"
             implementation("org.spockframework:spock-core") { transitive = false }
         }
-
-        documentation "org.fusesource.jansi:jansi:2.4.0"
-        documentation "org.apache.groovy:groovy-dateutil"
-        documentation 'info.picocli:picocli:4.6.3'
-        documentation ("com.github.javaparser:javaparser-core:$javaParserCoreVersion")
     }
 
     if (project.name == "grace-datastore-gorm-async") {
@@ -140,10 +134,6 @@ subprojects {
         options.jFlags "-Xms64M", "-Xmx512M"
     }
 
-    configure([groovydoc]) {
-        classpath += configurations.documentation
-    }
-
     publishing {
         publications {
             maven(MavenPublication) {
@@ -197,6 +187,51 @@ subprojects {
     }
 }
 
+dependencies {
+    documentation "com.github.javaparser:javaparser-core:$javaParserCoreVersion"
+    documentation "org.apache.groovy:groovy:$groovyVersion"
+    documentation "org.apache.groovy:groovy-ant:$groovyVersion"
+}
+
+def cleanTask = project.tasks.findByName('clean')
+if (cleanTask == null) {
+    task clean(type: Delete) {
+        delete(buildDir)
+    }
+}
+else {
+    cleanTask.doLast {
+        ant.delete(dir: 'build/docs')
+    }
+}
+
+tasks.withType(Groovydoc) {
+    group = 'Documentation'
+    docTitle = "Grace Data - ${project.version}"
+    destinationDir = project.file('build/docs/manual/api')
+    def files = []
+    project.rootProject.subprojects
+            .findAll { !it.name != 'docs' && !it.name.startsWith('examples') }
+            .each { subproject ->
+                if(subproject.file('src/main/groovy').exists()) {
+                    files += subproject.files('src/main/groovy')
+                }
+                if(subproject.file('src/main/java').exists()) {
+                    files += subproject.files('src/main/java')
+                }
+            }
+    if (project.file('src/main/groovy').exists()) {
+        files += project.files('src/main/groovy')
+    }
+    source = files
+    classpath += configurations.documentation
+}
+
+docs {
+    dependsOn groovydoc
+    sourceDir = project.file('src/docs')
+}
+
 project.afterEvaluate {
     allprojects.repositories.each { handler ->
         handler.each {

gradle.properties

@@ -1,9 +1,4 @@
-title=Grace Data
-projectDesc=Grace Data Access Framework
-projectUrl=https://github.com/graceframework/grace-data
 projectVersion=2023.3.0-SNAPSHOT
-githubSlug=graceframework/grace-data
-developers=Michael Yan
 commonsValidatorVersion=1.9.0
 dependencyManagementPluginVersion=1.1.7
 elImplVersion=4.0.2

src/docs/guide/gettingStarted.adoc

@@ -0,0 +1,41 @@
+=== Checking out and Building 
+
+The project is https://github.com/graceframework/grails-data[hosted on GitHub].
+
+You are free to fork the project from there or clone it anonymously using git:
+
+----
+git clone https://github.com/graceframework/grails-data.git
+cd grace-data
+----
+
+The project has a https://gradle.org[Gradle] build.
+
+To build the project you can run the `assemble` task:
+
+[source, bash]
+----
+./gradlew assemble
+----
+
+To install the jar files for the various subprojects into your local Maven repository you can run:
+
+[source, bash]
+----
+./gradlew publishToMavenLocal
+----
+
+=== Project Structure
+
+The project is essentially a multi-project Gradle build. There is a core API and then subprojects that implement that API. The core API subprojects include:
+
+* `grace-datastore-core` - The core API, this provides core interfaces for implementing a GORM provider
+* `grace-datastore-gorm` - The runtime meta-programming and AST transformation infrastructure behind GORM. This also provides end users with APIs like `grails.gorm.CriteriaBuilder` and `grails.gorm.DetachedCriteria`
+* `grace-datastore-gorm-support` - Support classes for easing the writing of a GORM plugin for Grails
+* `grace-datastore-gorm-tck` - The TCK that includes hundreds of Spock specifications that a GORM implementation will need to pass
+* `grace-datastore-web` - Classes required to integrate GORM into a web tier
+
+In addition to this, there are separate projects of GORM implementations for various datastores:
+
+* https://github.com/graceframework/grace-data-hibernate[Grace Data Hibernate]
+* https://github.com/graceframework/grace-data-mongodb[Grace Data MongoDB]

src/docs/guide/index.adoc

@@ -0,0 +1,64 @@
+:imagesdir: ./images
+:source-highlighter: coderay
+:toc: left
+:toc-title: GORM Developer Guide
+:numbered:
+:last-update-label!:
+
+= GORM Developer Guide
+Graeme Rocher
+
+[[introduction]]
+== Introduction
+
+include::introduction.adoc[]
+
+[[gettingStarted]]
+== Getting Started
+
+include::gettingStarted.adoc[]
+
+[[understandingApi]]
+== Understanding the GORM API
+
+include::understandingApi.adoc[]
+
+[[datastoreBasics]]
+=== Datastore Basics
+
+include::understandingApi/datastoreBasics.adoc[]
+
+[[implementingCrud]]
+=== Implementing CRUD
+
+include::understandingApi/implementingCrud.adoc[]
+
+[[secondaryIndexes]]
+=== Secondary Indexing
+
+include::understandingApi/secondaryIndexes.adoc[]
+
+[[implementingQueries]]
+=== Implementing Querying
+
+include::understandingApi/implementingQueries.adoc[]
+
+[[gormEnhancer]]
+=== GORM Enhancer
+
+include::understandingApi/gormEnhancer.adoc[]
+
+[[gormApis]]
+=== Adding to GORM APIs
+
+include::understandingApi/gormApis.adoc[]
+
+[[testing]]
+== Using the Test Compatibility Kit
+
+include::testing.adoc[]
+
+[[stepByStep]]
+== Step-by-Step Guide to Creating an Implementation
+
+include::stepByStep.adoc[]

src/docs/guide/introduction.adoc

@@ -0,0 +1,9 @@
+This documentation describes the GORM API mechanics and how a datastore implementation can be built to interface to any database providing a GORM API onto it. This documentation is mainly targeted at developers interested in creating implementations of GORM on top of alternative datastores.
+
+As of this writing the project has several implementations of GORM against a variety of different datastore implementations. Current implementations include:
+
+* Hibernate 5
+* MongoDB
+* java.util.ConcurrentHashMap (the fastest datastore in the world)
+
+The remainder of this document describes how the project is structured, how to build a project and how to implement a GORM provider.