Skip to content

Commit

Permalink
Fix documentation, plugin descriptor
Browse files Browse the repository at this point in the history
  • Loading branch information
jameskleeh committed Apr 11, 2017
1 parent 0c265ef commit 4fc36d1
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ plugins {
id 'org.asciidoctor.convert' version '1.5.3'
}

version "1.0.2"
version "1.0.3"
group "org.grails.plugins"

apply plugin:"eclipse"
Expand Down Expand Up @@ -84,7 +84,7 @@ task apidocs(type: Groovydoc) {

destinationDir = new File(buildDir, 'docs/api')
// Might need a classpath
docTitle = "Grails Angular Scaffolding ${version}"
docTitle = "Grails AngularJS Scaffolding ${version}"

classpath = configurations.documentation
groovyClasspath = configurations.documentation
Expand Down
2 changes: 1 addition & 1 deletion src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Grails Angular Scaffolding Plugin
= Grails AngularJS Scaffolding Plugin
:author: James Kleeh
:email: kleehj@ociweb.com
:source-highlighter: coderay
Expand Down
2 changes: 1 addition & 1 deletion src/docs/asciidoc/installation/index.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
== Installation

To start using this plugin, add it to your `build.gradle` like the example below. If you created your project with the angular profile in Grails 3.2.0 or higher, this is done automatically.
To start using this plugin, add it to your `build.gradle` like the example below. If you created your project with the angularjs profile, this is done automatically.

[source,groovy,subs="attributes",indent=1]
.build.gradle
Expand Down
10 changes: 5 additions & 5 deletions src/docs/asciidoc/usage/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@ The scaffolding will look for `/grails-app/assets/javascripts/com/foo/core/com.f

=== Assumptions

This plugin needs certain third party libraries to function and it assumes they are available. In addition to angular itself, the plugin relies on link:https://github.com/angular-ui/ui-router[ui-router] for routing and the Angular resource module for making REST calls.
This plugin needs certain third party libraries to function and it assumes they are available. In addition to Angular itself, the plugin relies on link:https://github.com/angular-ui/ui-router[ui-router] for routing and the Angular resource module for making REST calls.

If you are using this plugin without the angular profile in Grails 3.2.0 or greater, it will be up to you to ensure those assets are available in the project. You can inform the plugin of their location with configuration.
If you are using this plugin without the angularjs profile, it will be up to you to ensure those assets are available in the project. You can inform the plugin of their location with configuration.

Here is how you might use the link:https://github.com/craigburke/client-dependencies-gradle[Client Dependencies] plugin to download the required assets automatically and put them in the place the scaffolding expects by default.

Expand Down Expand Up @@ -96,7 +96,7 @@ clientDependencies {

=== REST API

The scaffolding generated by this plugin includes code to configure an Angular https://docs.angularjs.org/api/ngResource/service/$resource[$resource] for the given domain object. The `$resource` defines how the Angular domain class communicates with the back-end API endpoints for retrieving and manipulating the domain object.
The scaffolding generated by this plugin includes code to configure an AngularJS https://docs.angularjs.org/api/ngResource/service/$resource[$resource] for the given domain object. The `$resource` defines how the Angular domain class communicates with the back-end API endpoints for retrieving and manipulating the domain object.

The generated `$resource` assumes that the server offers an API using a standard REST pattern, as per the following example for a domain object mapped to the `/book` URL:

Expand All @@ -113,7 +113,7 @@ The generated `$resource` assumes that the server offers an API using a standard

==== Dependencies

The generated scaffolding assumes the following asset pipeline plugins are being used in your project. If you are using the angular profile, the necessary dependencies are included by default.
The generated scaffolding assumes the following asset pipeline plugins are being used in your project. If you are using the angularjs profile, the necessary dependencies are included by default.

[source,groovy,indent=1]
.build.gradle
Expand Down Expand Up @@ -151,7 +151,7 @@ grails:

=== Routing

If you are using the angular profile in Grails 3.2.0 or higher, the default index page is modified so that clicking on the link to the controller will automatically route you to the module the controller represents. If you are using this plugin in an existing application, you will have a little bit of work to do to use the generated assets.
If you are using the angularjs profile, the default index page is modified so that clicking on the link to the controller will automatically route you to the module the controller represents. If you are using this plugin in an existing application, you will have a little bit of work to do to use the generated assets.

The first step is to ensure the module is included in the page. If a parent module is found, a dependency will automatically be created, however it is up to you to ensure the parent module or the generated module is included on the page using asset pipeline as you normally would.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ class GrailsAngularScaffoldingGrailsPlugin extends Plugin {
def grailsVersion = "3.1.0 > *"

// TODO Fill in these fields
def title = "Grails Angular Scaffolding" // Headline output name of the plugin
def title = "Grails AngularJS Scaffolding" // Headline output name of the plugin
def author = "James Kleeh"
def authorEmail = "kleehj@ociweb.com"
def description = '''\
This plugin provides the ability to generate an AngularJS CRUD interface based on a domain class
'''
String documentation = 'http://grails-plugins.github.io/grails-angular-scaffolding/latest'
String documentation = 'http://grails-plugins.github.io/grails-angularjs-scaffolding/latest'
String license = 'APACHE'
def organization = [name: 'Grails', url: 'http://www.grails.org/']
def issueManagement = [url: 'https://github.com/grails-plugins/grails-angular-scaffolding/issues']
def scm = [url: 'https://github.com/grails-plugins/grails-angular-scaffolding']
def issueManagement = [url: 'https://github.com/grails-plugins/grails-angularjs-scaffolding/issues']
def scm = [url: 'https://github.com/grails-plugins/grails-angularjs-scaffolding']

Closure doWithSpring() { {->
scaffoldingCoreConfig(ScaffoldingBeanConfiguration)
Expand Down

0 comments on commit 4fc36d1

Please sign in to comment.