docs: improved wording in many places

goreleaser · Aug 28, 2022 · 999cf91 · 999cf91
1 parent 4a67c76
commit 999cf91
Show file tree

Hide file tree

Showing 10 changed files with 16 additions and 16 deletions.
diff --git a/www/docs/ci/drone.md b/www/docs/ci/drone.md
@@ -1,7 +1,7 @@
 # Drone
 
-By default, drone does not fetch tags. `plugins/git` is used with default values,
-in most cases we'll need overwrite the `clone` step enabling tags in order to make
+By default, drone does not fetch tags. `plugins/git` is used with default
+values, in most cases we'll need overwrite the `clone` step enabling tags, so
 `goreleaser` work correctly.
 
 In this example we're creating a new release every time a new tag is pushed.

diff --git a/www/docs/ci/gitlab.md b/www/docs/ci/gitlab.md
@@ -47,7 +47,7 @@ for more information.
 
 When tags are pushed to the repository,
 an available GitLab Runner with the Docker executor will pick up the release job.
-`goreleaser/goreleaser` will start in a container and the repository will be mounted inside.
+`goreleaser/goreleaser` will start in a container, and the repository will be mounted inside.
 Finally, the `script` section will run within the container starting in your project's directory.
 
 ## Releasing Archives and Pushing Images

diff --git a/www/docs/ci/travis.md b/www/docs/ci/travis.md
@@ -1,6 +1,6 @@
 # Travis CI
 
-You may want to setup your project to auto-deploy your new tags on
+You may want to set up your project to auto-deploy your new tags on
 [Travis](https://travis-ci.org), for example:
 
 ```yaml

diff --git a/www/docs/intro.md b/www/docs/intro.md
@@ -3,18 +3,18 @@
 GoReleaser is a release automation tool for Go projects.
 The goal is to simplify the build, release and publish steps while providing variant customization options for all steps.
 
-It has been widely adopted by the Go community in the past 5 years, with [thousands of projects](https://github.com/search?l=&q=filename%3Agoreleaser+language%3Ayaml+-path%3A%2Fvendor&type=code) it to manage their releases.
+It has been widely adopted by the Go community in the past years, with [thousands of projects](https://github.com/search?l=&q=filename%3Agoreleaser+language%3Ayaml+-path%3A%2Fvendor&type=code) it to manage their releases.
 You can check some of our users out [here](/users).
 
-GoReleaser was built with CI tools in mind - you only really need to download and execute it in your build script.
+GoReleaser was built with CI tools in mind — you only really need to download and execute it in your build script.
 Installing it in your machine is optional.
 
 Your entire release process can be customized through a `.goreleaser.yml` file.
 Once you set it up, every time you want to create a new release, all you need to do is tag and run `goreleaser release`:
 
 <script id="asciicast-385826" src="https://asciinema.org/a/385826.js" async></script>
 
-Hopefully you find it useful and the docs easy to follow.
+Hopefully you find it useful, and the docs easy to follow.
 Feel free to [create an issue][iss] if you find something that's not clear and join our [Discord][dis] to chat with other users and maintainers.
 
 [iss]: https://github.com/goreleaser/goreleaser/issues

diff --git a/www/docs/limitations/cgo.md b/www/docs/limitations/cgo.md
@@ -1,7 +1,7 @@
 # CGO
 
 If you need to cross-compile with CGO enabled, our Docker image is not
-supported and your config will not look that "clean", unfortunately.
+supported, and your configuration will not look that "clean", unfortunately.
 
 You can check [this cookbook](/cookbooks/cgo-and-crosscompiling/) for an
 example.

diff --git a/www/docs/limitations/semver.md b/www/docs/limitations/semver.md
@@ -1,6 +1,6 @@
 # Semantic Versioning
 
-GoReleaser enforces semantic versioning and will error on non compliant tags.
+GoReleaser enforces semantic versioning and will error on non-compliant tags.
 
 Your tag **should** be a valid [semantic version](http://semver.org/).
 If it is not, GoReleaser will error.

diff --git a/www/docs/quick-start.md b/www/docs/quick-start.md
@@ -45,9 +45,9 @@ You can also use GoReleaser to [build](/cmd/goreleaser_build/) the binary only f
 goreleaser build --single-target
 ```
 
-In order to release to GitHub, you'll need to export a `GITHUB_TOKEN` environment variable, which should contain a valid GitHub token with the `repo` scope.
+To release to GitHub, you'll need to export a `GITHUB_TOKEN` environment variable, which should contain a valid GitHub token with the `repo` scope.
 It will be used to deploy releases to your GitHub repository.
-You can create a new github token [here](https://github.com/settings/tokens/new).
+You can create a new GitHub token [here](https://github.com/settings/tokens/new).
 
 !!! info
     The minimum permissions the `GITHUB_TOKEN` should have to run this are `write:packages`

diff --git a/www/docs/scm/gitea.md b/www/docs/scm/gitea.md
@@ -19,7 +19,7 @@ env_files:
 ## URLs
 
 You can use GoReleaser with Gitea by providing its URLs in
-the `.goreleaser.yaml` configuration file. This takes a normal string or a template value.
+the `.goreleaser.yaml` configuration file. This takes a normal string, or a template value.
 
 ```yaml
 # .goreleaser.yaml

diff --git a/www/docs/scm/github.md b/www/docs/scm/github.md
@@ -19,7 +19,7 @@ env_files:
 ## GitHub Enterprise
 
 You can use GoReleaser with GitHub Enterprise by providing its URLs in the
-`.goreleaser.yaml` configuration file. This takes a normal string or a template
+`.goreleaser.yaml` configuration file. This takes a normal string, or a template
 value.
 
 ```yaml

diff --git a/www/docs/scm/gitlab.md b/www/docs/scm/gitlab.md
@@ -3,7 +3,7 @@
 ## API Token
 
 GoReleaser requires an API token with the `api` scope selected to deploy the artifacts to GitLab.
-That token can either be a Personal or a Project one.
+That token can either be a Personal, or a Project one.
 
 This token should be added to the environment variables as `GITLAB_TOKEN`.
 
@@ -23,7 +23,7 @@ env_files:
 ## GitLab Enterprise or private hosted
 
 You can use GoReleaser with GitLab Enterprise by providing its URLs in the
-`.goreleaser.yml` configuration file. This takes a normal string or a template value.
+`.goreleaser.yml` configuration file. This takes a normal string, or a template value.
 
 ```yaml
 # .goreleaser.yml
@@ -53,7 +53,7 @@ If none are set, they default to GitLab's public URLs.
 
 GitLab introduced the [Generic Package Registry](https://docs.gitlab.com/ee/user/packages/package_registry/index.html) in Gitlab 13.5.
 
-Normally, `goreleaser` uploads release files as "attachments", which may have [administrative limits](https://docs.gitlab.com/ee/user/admin_area/settings/account_and_limit_settings.html).  Notably, hosted gitlab.com instances have a 10MB attachment limit which cannot be changed.
+Normally, `goreleaser` uploads release files as "attachments", which may have [administrative limits](https://docs.gitlab.com/ee/user/admin_area/settings/account_and_limit_settings.html).  Notably, hosted gitlab.com instances have a 10MB attachment limit, which cannot be changed.
 
 Uploading to the Generic Package Registry does not have this restriction.  To use it instead, set `use_package_registry` to `true`.