Skip to content
This repository was archived by the owner on Feb 28, 2025. It is now read-only.

Commit 4fc36d1

Browse files
committed
Fix documentation, plugin descriptor
1 parent 0c265ef commit 4fc36d1

File tree

5 files changed

+13
-13
lines changed

5 files changed

+13
-13
lines changed

build.gradle

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ plugins {
1212
id 'org.asciidoctor.convert' version '1.5.3'
1313
}
1414

15-
version "1.0.2"
15+
version "1.0.3"
1616
group "org.grails.plugins"
1717

1818
apply plugin:"eclipse"
@@ -84,7 +84,7 @@ task apidocs(type: Groovydoc) {
8484

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

8989
classpath = configurations.documentation
9090
groovyClasspath = configurations.documentation

src/docs/asciidoc/index.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Grails Angular Scaffolding Plugin
1+
= Grails AngularJS Scaffolding Plugin
22
:author: James Kleeh
33
44
:source-highlighter: coderay

src/docs/asciidoc/installation/index.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
== Installation
22

3-
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.
3+
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.
44

55
[source,groovy,subs="attributes",indent=1]
66
.build.gradle

src/docs/asciidoc/usage/index.adoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ The scaffolding will look for `/grails-app/assets/javascripts/com/foo/core/com.f
6161

6262
=== Assumptions
6363

64-
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.
64+
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.
6565

66-
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.
66+
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.
6767

6868
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.
6969

@@ -96,7 +96,7 @@ clientDependencies {
9696

9797
=== REST API
9898

99-
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.
99+
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.
100100

101101
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:
102102

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

114114
==== Dependencies
115115

116-
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.
116+
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.
117117

118118
[source,groovy,indent=1]
119119
.build.gradle
@@ -151,7 +151,7 @@ grails:
151151

152152
=== Routing
153153

154-
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.
154+
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.
155155

156156
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.
157157

src/main/groovy/org/grails/plugin/scaffolding/angular/GrailsAngularScaffoldingGrailsPlugin.groovy

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ class GrailsAngularScaffoldingGrailsPlugin extends Plugin {
1414
def grailsVersion = "3.1.0 > *"
1515

1616
// TODO Fill in these fields
17-
def title = "Grails Angular Scaffolding" // Headline output name of the plugin
17+
def title = "Grails AngularJS Scaffolding" // Headline output name of the plugin
1818
def author = "James Kleeh"
1919
def authorEmail = "[email protected]"
2020
def description = '''\
2121
This plugin provides the ability to generate an AngularJS CRUD interface based on a domain class
2222
'''
23-
String documentation = 'http://grails-plugins.github.io/grails-angular-scaffolding/latest'
23+
String documentation = 'http://grails-plugins.github.io/grails-angularjs-scaffolding/latest'
2424
String license = 'APACHE'
2525
def organization = [name: 'Grails', url: 'http://www.grails.org/']
26-
def issueManagement = [url: 'https://github.com/grails-plugins/grails-angular-scaffolding/issues']
27-
def scm = [url: 'https://github.com/grails-plugins/grails-angular-scaffolding']
26+
def issueManagement = [url: 'https://github.com/grails-plugins/grails-angularjs-scaffolding/issues']
27+
def scm = [url: 'https://github.com/grails-plugins/grails-angularjs-scaffolding']
2828

2929
Closure doWithSpring() { {->
3030
scaffoldingCoreConfig(ScaffoldingBeanConfiguration)

0 commit comments

Comments
 (0)