Skip to content

Conversation

@jamesfredley
Copy link
Contributor

@jamesfredley jamesfredley commented Aug 26, 2025

Introduces new documentation sections and files for each standard Grails application profile, including web, REST API, plugin, web-plugin, rest-api-plugin, and profile profiles.

Resolves: #14695

Introduces new documentation sections and files for each default Grails application profile, including web, REST API, plugin, web-plugin, rest-api-plugin, and profile profiles. Updates the guide index and table of contents to reference these new sections, providing users with comprehensive information on available profiles, their commands, and features.
@jamesfredley jamesfredley self-assigned this Aug 26, 2025
@jamesfredley jamesfredley moved this to In Progress in Apache Grails Aug 26, 2025
@jamesfredley jamesfredley added this to the grails:7.0.0-RC2 milestone Aug 26, 2025
@jamesfredley jamesfredley linked an issue Aug 26, 2025 that may be closed by this pull request
@jamesfredley jamesfredley changed the title Add detailed documentation for default Grails application profiles Add detailed documentation for standard Grails application profiles Aug 27, 2025
Updated documentation to refer to 'Standard Profiles' instead of 'Default Profiles'. Renamed the relevant AsciiDoc file, updated references in the index and table of contents, and adjusted terminology for consistency.
Copy link
Contributor

@sbglasius sbglasius left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a developer perhaps it would be nice to elaborate over the profile profile. I for one don't know how to use it 🙂

@dauer
Copy link
Contributor

dauer commented Aug 27, 2025

@jamesfredley the grails package-plugin is mentioned in the documentation so I guess this #11613 is no longer relevant.
I tested creating a Grails 4.0.4 plugin and I have the package-plugin command, I am not sure it is a Grails issue, probably as missing plugin or dependency in his project....

This is probaly not relevant any more
#14091

Copy link
Contributor

@matrei matrei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The section 6.4 Publishing Profiles (which is outside this PR) has this snippet:

grailsPublish { githubSlug = 'foo/bar' license { name = 'Apache-2.0' } title = 'My plugin title' desc = 'My plugin description' developers = [johndoe: 'John Doe'] }

which should probably be:

grailsPublish { githubSlug = 'foo/bar' license { name = 'Apache-2.0' } title = 'My profile title' desc = 'My profile description' developers = [johndoe: 'John Doe'] }
@jamesfredley
Copy link
Contributor Author

#11613 and #14091 have been updated and closed given package-plugin is available for projects with grails profiles plugin, web-plugin and rest-api-plugin.

@jamesfredley
Copy link
Contributor Author

@sbglasius Do you think 6.1 - 6.6 on https://docs.grails.org/snapshot/guide/profiles.html#creatingProfiles cover the profile profile well or should we create an issue to add further improvements?

Changed example values for 'title' and 'desc' from 'My plugin title/description' to 'My profile title/description' to better reflect the context of profile publishing.
@jamesfredley
Copy link
Contributor Author

section 6.4 Publishing Profiles has been updated

@jamesfredley jamesfredley merged commit 581e131 into 7.0.x Aug 28, 2025
33 checks passed
@jamesfredley jamesfredley deleted the add-default-profile-docs branch August 28, 2025 14:15
@github-project-automation github-project-automation bot moved this from In Progress to Done in Apache Grails Aug 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

4 participants