This is an automated email from the ASF dual-hosted git repository. jamesfredley pushed a commit to branch grails-forge-documentation in repository https://gitbox.apache.org/repos/asf/grails-core.git
commit cd61d78099fd2231eaf9a27561cf1df10348d61f Author: James Fredley <[email protected]> AuthorDate: Thu Aug 21 11:42:07 2025 -0400 Remove grails-forge documentation guide Remove grails-forge documentation guide It is thoroughly covered in grails-doc --- grails-forge/src/main/docs/guide/installation.adoc | 18 ------ .../docs/guide/installation/installFromSource.adoc | 71 ---------------------- .../docs/guide/installation/installSdkman.adoc | 53 ---------------- .../docs/guide/installation/installWindows.adoc | 32 ---------- grails-forge/src/main/docs/guide/introduction.adoc | 19 ------ .../src/main/docs/guide/releaseHistory.adoc | 31 ---------- grails-forge/src/main/docs/guide/starterImpls.adoc | 22 ------- grails-forge/src/main/docs/guide/toc.yml | 22 ------- 8 files changed, 268 deletions(-) diff --git a/grails-forge/src/main/docs/guide/installation.adoc b/grails-forge/src/main/docs/guide/installation.adoc deleted file mode 100644 index 7edcd33616..0000000000 --- a/grails-forge/src/main/docs/guide/installation.adoc +++ /dev/null @@ -1,18 +0,0 @@ -//// -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - -https://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. -//// \ No newline at end of file diff --git a/grails-forge/src/main/docs/guide/installation/installFromSource.adoc b/grails-forge/src/main/docs/guide/installation/installFromSource.adoc deleted file mode 100644 index 4fad6d0c8f..0000000000 --- a/grails-forge/src/main/docs/guide/installation/installFromSource.adoc +++ /dev/null @@ -1,71 +0,0 @@ -//// -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - -https://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. -//// -Clone the repository as follows: - -[source,bash] ----- -$ git clone https://github.com/apache/grails-core.git ----- - - -`cd` into the `grails-core/grails-forge` directory and run the following command: - -[source,bash] ----- -$ ./gradlew grails-forge-cli:assembleDist ----- - -This will create a zip distribution of the CLI (named with the current version) in the `grails-forge-cli/build/distributions/` folder. - -You'll need to unzip this somewhere convenient. For example, to unzip it to a dot directory in your user home, you could do: - -[source,bash] ----- -$ mkdir ~/.grails -$ unzip grails-forge-cli/build/distributions/apache-grails-forge-cli-VERSION-incubating-bin.zip -d ~/.grails ----- - -In your shell profile (`~/.bash_profile` if you are using the Bash shell), export the `GRAILS_HOME` directory (wherever you unzipped it to) and add the CLI path to your `PATH`: - -.bash_profile/.bashrc -[source,bash] ----- -export GRAILS_HOME=~/path/to/unzipped/cli -export PATH="$PATH:$GRAILS_HOME/bin" ----- - -TIP: If you're using SDKMAN and don't want to mess with your $GRAILS_HOME, you can also point SDKMAN to your -local installation for dev purposes by using `sdk install grails dev path/to/unzipped/cli` - -Reload your terminal or `source` your shell profile with `source`: - -[source,bash] ----- -$ source ~/.bash_profile ----- - -You will now be able to run the Grails Forge CLI. - -[source,bash] ----- -$ grails -| Starting interactive mode... -| Enter a command name to run. Use TAB for completion: -grails> ----- diff --git a/grails-forge/src/main/docs/guide/installation/installSdkman.adoc b/grails-forge/src/main/docs/guide/installation/installSdkman.adoc deleted file mode 100644 index ef120295b3..0000000000 --- a/grails-forge/src/main/docs/guide/installation/installSdkman.adoc +++ /dev/null @@ -1,53 +0,0 @@ -//// -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - -https://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. -//// -The best way to install Grails on Unix systems is with http://sdkman.io/[SDKMAN] which greatly simplifies installing -and managing multiple Grails versions. - -Before updating make sure you have latest version of SDKMAN installed. If not, run - -[source,bash] ----- -$ sdk update ----- - -In order to install Grails, run following command: - -[source,bash] ----- -$ sdk install grails ----- - -You can also specify the version to the `sdk install` command. - -[source,bash,subs="attributes"] ----- -$ sdk install grails {project-version} ----- - -You can find more information about SDKMAN usage on the http://sdkman.io/usage[SDKMAN Docs] - -You should now be able to run the Grails Forge CLI. - -[source,bash] ----- -$ grails -| Starting interactive mode... -| Enter a command name to run. Use TAB for completion: -grails> ----- \ No newline at end of file diff --git a/grails-forge/src/main/docs/guide/installation/installWindows.adoc b/grails-forge/src/main/docs/guide/installation/installWindows.adoc deleted file mode 100644 index 098fad2cc5..0000000000 --- a/grails-forge/src/main/docs/guide/installation/installWindows.adoc +++ /dev/null @@ -1,32 +0,0 @@ -//// -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - -https://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. -//// -* Download the latest binary from https://github.com/apache/grails-core/releases/[Grails Forge Release] -* Extract the binary to appropriate location (For example: `C:\grails`) -* Create an environment variable `GRAILS_HOME` which points to the installation directory i.e. `C:\grails` -* Update the `PATH` environment variable, append `%GRAILS_HOME%\bin`. - -You should now be able to run the Grails Forge CLI from the command prompt as follows: - -[source,bash] ----- -$ grails -| Starting interactive mode... -| Enter a command name to run. Use TAB for completion: -grails> ----- diff --git a/grails-forge/src/main/docs/guide/introduction.adoc b/grails-forge/src/main/docs/guide/introduction.adoc deleted file mode 100644 index 7fff9432fa..0000000000 --- a/grails-forge/src/main/docs/guide/introduction.adoc +++ /dev/null @@ -1,19 +0,0 @@ -//// -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - -https://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. -//// -This project implements a project generator for Grails as is both a Command Line (CLI) application and an API that can be run as a HTTP server, deployed to a Servlet container or executed on a Serverless platform (Google Cloud Run, Google Cloud Function, AWS Lambda or Azure Function). \ No newline at end of file diff --git a/grails-forge/src/main/docs/guide/releaseHistory.adoc b/grails-forge/src/main/docs/guide/releaseHistory.adoc deleted file mode 100644 index 5384990d44..0000000000 --- a/grails-forge/src/main/docs/guide/releaseHistory.adoc +++ /dev/null @@ -1,31 +0,0 @@ -//// -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - -https://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. -//// -==== 6.0.0-M4 - -* In the previous release, the grailsVersion and grailsGradlePlugin version points to the 6.0.0-SNAPSHOT for a newly created Grails application. This Release fix the problem by correctly pointing them to 6.0.0-M4. -* There was no embedded servlet selected by default, but this release select Embedded Tomcat as the default servlet implementation. -* Add New Option for selecting the Embedded Servlet implementation between Tomcat, Jetty, Undertow, or None. - -==== 6.0.0-M3 - -* Initial Milestone Release - -==== 6.0.0-M2 - -* Initial Milestone Release \ No newline at end of file diff --git a/grails-forge/src/main/docs/guide/starterImpls.adoc b/grails-forge/src/main/docs/guide/starterImpls.adoc deleted file mode 100644 index 9e08eac1e4..0000000000 --- a/grails-forge/src/main/docs/guide/starterImpls.adoc +++ /dev/null @@ -1,22 +0,0 @@ -//// -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - -https://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. -//// -The core functionality of the project generator is contained within the `micronaut-starter-core` subproject: - -dependency:io.micronaut.starter:micronaut-starter-core[version="{version}"] - diff --git a/grails-forge/src/main/docs/guide/toc.yml b/grails-forge/src/main/docs/guide/toc.yml deleted file mode 100644 index d1a9381dbe..0000000000 --- a/grails-forge/src/main/docs/guide/toc.yml +++ /dev/null @@ -1,22 +0,0 @@ -# Licensed to the Apache Software Foundation (ASF) under one or more -# contributor license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright ownership. -# The ASF licenses this file to You under the Apache License, Version 2.0 -# (the "License"); you may not use this file except in compliance with -# the License. You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -introduction: Introduction -installation: - title: Installation - installSdkman: Install with SDKman - installWindows: Install through Binary on Windows - installFromSource: Build & Install from Source -releaseHistory: Release History \ No newline at end of file
