Update documentation to use the new way to run scripts

grails · Aug 24, 2023 · a0b3ecd · a0b3ecd
1 parent 044d886
commit a0b3ecd
Show file tree

Hide file tree

Showing 8 changed files with 54 additions and 38 deletions.
diff --git a/gradle/docs.gradle b/gradle/docs.gradle
@@ -13,7 +13,11 @@ if (parts.length >= 3) {
     } else if (parts[2].contains('-')) {
         final String[] subparts = parts[2].split("-")
         patch = subparts.first() as int
-        stableVersion = "${major}.${minor}.${patch - 1}"
+        if (patch == 0) {
+            stableVersion = "${major}.${minor}.${patch}"
+        } else {
+            stableVersion = "${major}.${minor}.${patch - 1}"
+        }
         snapshotVersion = "${major}.${minor}." + subparts[1..-1].join("-")
     } else {
         stableVersion = versionTxt

diff --git a/plugin/src/docs/hierarchicalRoles.adoc b/plugin/src/docs/hierarchicalRoles.adoc
@@ -69,9 +69,10 @@ Specifying a static string in the `roleHierarchy` property will be sufficient fo
 
 For example, running
 
-....
-$ grails s2-create-role-hierarchy-entry com.yourapp.RoleHierarchyEntry
-....
+[source,bash]
+----
+./gradlew runCommand "-Pargs=s2-create-role-hierarchy-entry com.yourapp.RoleHierarchyEntry"
+----
 
 will generate this class in `grails-app/domain/com/yourapp/RoleHierarchyEntry.groovy`:
 

diff --git a/plugin/src/docs/installation.adoc b/plugin/src/docs/installation.adoc
@@ -17,10 +17,11 @@ Ensure you have the following set up:
 3. Add the Spring Security Core Plugin dependency to the `dependencies` section in your `build.gradle`:
 
 [source,groovy]
+[subs="attributes"]
 ----
 dependencies {
     // ... other dependencies
-    implementation 'org.grails.plugins:spring-security-core:${stableVersion}'
+    implementation 'org.grails.plugins:spring-security-core:{stableversion}'
 }
 ----
 

diff --git a/plugin/src/docs/scripts/s2-create-persistent-token.adoc b/plugin/src/docs/scripts/s2-create-persistent-token.adoc
@@ -5,15 +5,17 @@
 
 Creates a persistent token domain class for storing remember-me cookie information in the database. The general format is:
 
-....
-grails s2-create-persistent-token <classname>
-....
+[source,bash]
+----
+./gradlew runCommand "-Pargs=s2-create-persistent-token <classname>"
+----
 
 .Example
 
-....
-grails s2-create-persistent-token com.yourapp.PersistentLogin
-....
+[source,bash]
+----
+./gradlew runCommand "-Pargs=s2-create-persistent-token com.yourapp.PersistentLogin"
+----
 
 .Description
 

diff --git a/plugin/src/docs/scripts/s2-create-role-hierarchy-entry.adoc b/plugin/src/docs/scripts/s2-create-role-hierarchy-entry.adoc
@@ -5,15 +5,17 @@
 
 Creates a persistent role hierarchy entry domain class for storing role hierarchy information in the database. The general format is:
 
-....
-grails s2-create-role-hierarchy-entry <classname>
-....
+[source,bash]
+----
+./gradlew runCommand "-Pargs=s2-create-role-hierarchy-entry <classname>"
+----
 
 .Example
 
-....
-grails s2-create-role-hierarchy-entry com.yourapp.RoleHierarchyEntry
-....
+[source,bash]
+----
+./gradlew runCommand "-Pargs=s2-create-role-hierarchy-entry com.yourapp.RoleHierarchyEntry"
+----
 
 .Description
 

diff --git a/plugin/src/docs/scripts/s2-quickstart.adoc b/plugin/src/docs/scripts/s2-quickstart.adoc
@@ -9,27 +9,32 @@ If you specify the uiOnly flag, no domain classes are created but the plugin set
 
 The general format is:
 
-....
-grails s2-quickstart DOMAIN_CLASS_PACKAGE USER_CLASS_NAME ROLE_CLASS_NAME [REQUESTMAP_CLASS_NAME] [--groupClassName=GROUP_CLASS_NAME]
-....
+[source,bash]
+----
+./gradlew runCommand "-Pargs=s2-quickstart DOMAIN_CLASS_PACKAGE USER_CLASS_NAME ROLE_CLASS_NAME [REQUESTMAP_CLASS_NAME] [--groupClassName=GROUP_CLASS_NAME]"
+----
 
 .Examples
 
-....
-grails s2-quickstart com.yourapp User Role
-....
-
-....
-grails s2-quickstart com.yourapp User Role --groupClassName=RoleGroup
-....
-
-....
-grails s2-quickstart com.yourapp Person Authority Requestmap
-....
-
-....
-grails s2-quickstart --uiOnly
-....
+[source,bash]
+----
+./gradlew runCommand "-Pargs=s2-quickstart com.yourapp User Role"
+----
+
+[source,bash]
+----
+./gradlew runCommand "-Pargs=s2-quickstart com.yourapp User Role --groupClassName=RoleGroup"
+----
+
+[source,bash]
+----
+./gradlew runCommand "-Pargs=s2-quickstart com.yourapp Person Authority Requestmap"
+----
+
+[source,bash]
+----
+./gradlew runCommand "-Pargs=s2-quickstart --uiOnly"
+----
 
 .Description
 

diff --git a/plugin/src/docs/thenewselectoption.png b/plugin/src/docs/thenewselectoption.png
diff --git a/plugin/src/docs/tutorials/usingControllerAnnotations.adoc b/plugin/src/docs/tutorials/usingControllerAnnotations.adoc
@@ -28,9 +28,10 @@ $ grails compile
 
 ==== 3. Create the User and Role domain classes.
 
-....
-$ grails s2-quickstart com.mycompany.myapp User Role
-....
+[source,bash]
+----
+./gradlew runCommand "-Pargs=s2-quickstart com.mycompany.myapp User Role"
+----
 
 You can choose your names for your domain classes and package; these are just examples.