gradle-enterprise-build-validation-scripts icon indicating copy to clipboard operation
gradle-enterprise-build-validation-scripts copied to clipboard

Build Scan capitalization appears consistent in user-facing text

Open etiennestuder opened this issue 2 years ago • 3 comments

etiennestuder avatar Oct 30 '22 13:10 etiennestuder

Is this still something that needs to be done?

runningcode avatar Sep 28 '23 19:09 runningcode

Yes.

etiennestuder avatar Sep 29 '23 05:09 etiennestuder

Additionally, we should be consistent with how we refer to the project.

The proper name is Develocity Build Validation Scripts. It should never be written as:

  • build validation scripts
  • Build Validation Scripts
  • validation scripts
  • scripts

When referring to an individual script (e.g. to execute), it should be fine to simply refer to it as a script. For example:

:white_check_mark: Each script represents a so-called experiment :white_check_mark: there are five different scripts that you can execute :white_check_mark: The following arguments are present on all scripts

Finally, we should be consistent with usages of script and experiment. It's easy to conflate the two which could be confusing to users. There may not be any action on this one, but I wanted to include it as something to keep in mind when writing any user facing text.

erichaagdev avatar Sep 07 '24 16:09 erichaagdev