From 2be6f399bfe5799ed98cecfddea28c6bf806782f Mon Sep 17 00:00:00 2001 From: Carlos A Becker Date: Sat, 30 Oct 2021 09:50:23 -0300 Subject: [PATCH] docs: improve search fixes #2616 --- www/docs/ci/actions.md | 4 +--- www/docs/cookbooks/blog-posts.md | 4 +--- www/docs/customization/archive.md | 4 +--- www/docs/customization/artifactory.md | 4 +--- www/docs/customization/blob.md | 4 +--- www/docs/customization/build.md | 4 +--- www/docs/customization/checksum.md | 4 +--- www/docs/customization/docker.md | 4 +--- www/docs/customization/docker_manifest.md | 4 +--- www/docs/customization/docker_sign.md | 4 +--- www/docs/customization/env.md | 4 +--- www/docs/customization/fury.md | 4 +--- www/docs/customization/gofish.md | 4 +--- www/docs/customization/gomod.md | 4 +--- www/docs/customization/homebrew.md | 4 +--- www/docs/customization/hooks.md | 4 +--- www/docs/customization/milestone.md | 4 +--- www/docs/customization/monorepo.md | 4 +--- www/docs/customization/nfpm.md | 4 +--- www/docs/customization/nightly.md | 4 +--- www/docs/customization/project.md | 4 +--- www/docs/customization/publishers.md | 4 +--- www/docs/customization/release.md | 4 +--- www/docs/customization/scoop.md | 4 +--- www/docs/customization/sign.md | 4 +--- www/docs/customization/snapcraft.md | 4 +--- www/docs/customization/snapshots.md | 4 +--- www/docs/customization/source.md | 4 +--- www/docs/customization/templates.md | 4 +--- www/docs/customization/universalbinaries.md | 4 +--- www/docs/customization/upload.md | 4 +--- www/docs/deprecations.md | 4 +--- www/docs/limitations/cgo.md | 4 +--- www/docs/limitations/semver.md | 4 +--- www/docs/links.md | 4 +--- www/docs/sponsors.md | 4 +--- 36 files changed, 36 insertions(+), 108 deletions(-) diff --git a/www/docs/ci/actions.md b/www/docs/ci/actions.md index 7ea17c2f9..5ca1d5124 100644 --- a/www/docs/ci/actions.md +++ b/www/docs/ci/actions.md @@ -1,6 +1,4 @@ ---- -title: GitHub Actions ---- +# GitHub Actions GoReleaser can also be used within our official [GoReleaser Action][goreleaser-action] through [GitHub Actions][actions]. diff --git a/www/docs/cookbooks/blog-posts.md b/www/docs/cookbooks/blog-posts.md index fd50a2c7d..068f5d734 100644 --- a/www/docs/cookbooks/blog-posts.md +++ b/www/docs/cookbooks/blog-posts.md @@ -1,6 +1,4 @@ ---- -title: Blog Posts ---- +# Blog Posts Tutorials made by the community. diff --git a/www/docs/customization/archive.md b/www/docs/customization/archive.md index eba5f2693..3008f0f85 100644 --- a/www/docs/customization/archive.md +++ b/www/docs/customization/archive.md @@ -1,6 +1,4 @@ ---- -title: Archives ---- +# Archives The binaries built will be archived together with the `README` and `LICENSE` files into a `tar.gz` file. In the `archives` section you can customize the archive name, diff --git a/www/docs/customization/artifactory.md b/www/docs/customization/artifactory.md index 785881345..7f9b3542e 100644 --- a/www/docs/customization/artifactory.md +++ b/www/docs/customization/artifactory.md @@ -1,6 +1,4 @@ ---- -title: Artifactory ---- +# Artifactory Publish your artifacts to an Artifactory instance. diff --git a/www/docs/customization/blob.md b/www/docs/customization/blob.md index b0da05829..c77b51bde 100644 --- a/www/docs/customization/blob.md +++ b/www/docs/customization/blob.md @@ -1,6 +1,4 @@ ---- -title: Blobs (s3, gcs, azblob) ---- +# Blobs (s3, gcs, azblob) The `blobs` allows you to upload artifacts to Amazon S3, Azure Blob and Google GCS. diff --git a/www/docs/customization/build.md b/www/docs/customization/build.md index 197034429..b8fa521f4 100644 --- a/www/docs/customization/build.md +++ b/www/docs/customization/build.md @@ -1,6 +1,4 @@ ---- -title: Builds ---- +# Builds Builds can be customized in multiple ways. You can specify for which `GOOS`, `GOARCH` and `GOARM` binaries are built diff --git a/www/docs/customization/checksum.md b/www/docs/customization/checksum.md index dcd6ccb34..6ec6bf679 100644 --- a/www/docs/customization/checksum.md +++ b/www/docs/customization/checksum.md @@ -1,6 +1,4 @@ ---- -title: Checksums ---- +# Checksums GoReleaser generates a `project_1.0.0_checksums.txt` file and uploads it with the release, so your users can validate if the downloaded files are correct. diff --git a/www/docs/customization/docker.md b/www/docs/customization/docker.md index b798ee6ea..10abf3fb8 100644 --- a/www/docs/customization/docker.md +++ b/www/docs/customization/docker.md @@ -1,6 +1,4 @@ ---- -title: Docker Images ---- +# Docker Images GoReleaser can build and push Docker images. Let's see how it works. diff --git a/www/docs/customization/docker_manifest.md b/www/docs/customization/docker_manifest.md index 57ab76b7e..43fef4138 100644 --- a/www/docs/customization/docker_manifest.md +++ b/www/docs/customization/docker_manifest.md @@ -1,6 +1,4 @@ ---- -title: Docker Manifests ---- +# Docker Manifests GoReleaser can also create and push Docker multi-platform images using the `docker manifest` tool. diff --git a/www/docs/customization/docker_sign.md b/www/docs/customization/docker_sign.md index febebf9d4..93803a585 100644 --- a/www/docs/customization/docker_sign.md +++ b/www/docs/customization/docker_sign.md @@ -1,6 +1,4 @@ ---- -title: Signing Docker Images and Manifests ---- +# Signing Docker Images and Manifests Signing Docker Images and Manifests is also possible with GoReleaser. This pipe was designed based on the common [sign](/customization/sign/) pipe having [cosign](https://github.com/sigstore/cosign) in mind. diff --git a/www/docs/customization/env.md b/www/docs/customization/env.md index c8575e0c0..88628d34b 100644 --- a/www/docs/customization/env.md +++ b/www/docs/customization/env.md @@ -1,6 +1,4 @@ ---- -title: Environment Variables ---- +# Environment Variables Global environment variables to be passed down to all hooks and builds. diff --git a/www/docs/customization/fury.md b/www/docs/customization/fury.md index bff9d2cc8..8c8095798 100644 --- a/www/docs/customization/fury.md +++ b/www/docs/customization/fury.md @@ -1,6 +1,4 @@ ---- -title: Fury.io (apt and rpm repositories) ---- +# Fury.io (apt and rpm repositories) !!! success "GoReleaser Pro" The fury.io publisher is a [GoReleaser Pro feature](/pro/). diff --git a/www/docs/customization/gofish.md b/www/docs/customization/gofish.md index 7e7018aa6..18e9066f8 100644 --- a/www/docs/customization/gofish.md +++ b/www/docs/customization/gofish.md @@ -1,6 +1,4 @@ ---- -title: GoFish ---- +# GoFish After releasing to GitHub or GitLab, GoReleaser can generate and publish a _Fish Food_ Cookbook into a repository that you have access to. diff --git a/www/docs/customization/gomod.md b/www/docs/customization/gomod.md index de676d1a5..a4eb06b93 100644 --- a/www/docs/customization/gomod.md +++ b/www/docs/customization/gomod.md @@ -1,6 +1,4 @@ ---- -title: Go Modules ---- +# Go Modules GoReleaser has support for creating verifiable builds. A [verifiable build][vgo] is one that records enough information to be precise about exactly how to repeat it. diff --git a/www/docs/customization/homebrew.md b/www/docs/customization/homebrew.md index 0438a5a1e..159b037c6 100644 --- a/www/docs/customization/homebrew.md +++ b/www/docs/customization/homebrew.md @@ -1,6 +1,4 @@ ---- -title: Homebrew Taps ---- +# Homebrew Taps After releasing to GitHub or GitLab, GoReleaser can generate and publish a _homebrew-tap_ recipe into a repository that you have access to. diff --git a/www/docs/customization/hooks.md b/www/docs/customization/hooks.md index 8bc813d36..96eb315bb 100644 --- a/www/docs/customization/hooks.md +++ b/www/docs/customization/hooks.md @@ -1,6 +1,4 @@ ---- -title: Global Hooks ---- +# Global Hooks Some release cycles may need run something before or after everything else. diff --git a/www/docs/customization/milestone.md b/www/docs/customization/milestone.md index 5a06a837f..9cee92d08 100644 --- a/www/docs/customization/milestone.md +++ b/www/docs/customization/milestone.md @@ -1,6 +1,4 @@ ---- -title: Closing Milestones ---- +# Closing Milestones GoReleaser can close repository milestones after successfully publishing all artifacts. diff --git a/www/docs/customization/monorepo.md b/www/docs/customization/monorepo.md index a66ddb9df..165de393f 100644 --- a/www/docs/customization/monorepo.md +++ b/www/docs/customization/monorepo.md @@ -1,6 +1,4 @@ ---- -title: Monorepo ---- +# Monorepo !!! success "GoReleaser Pro" The monorepo support is a [GoReleaser Pro feature](/pro/). diff --git a/www/docs/customization/nfpm.md b/www/docs/customization/nfpm.md index 1e5a6b81f..ce7b83a95 100644 --- a/www/docs/customization/nfpm.md +++ b/www/docs/customization/nfpm.md @@ -1,6 +1,4 @@ ---- -title: Linux packages (via nFPM) ---- +# Linux packages (via nFPM) GoReleaser can be wired to [nfpm](https://github.com/goreleaser/nfpm) to generate and publish `.deb`, `.rpm` and `.apk` packages. diff --git a/www/docs/customization/nightly.md b/www/docs/customization/nightly.md index 224ed3c2a..d3eb0fea1 100644 --- a/www/docs/customization/nightly.md +++ b/www/docs/customization/nightly.md @@ -1,6 +1,4 @@ ---- -title: Nightly ---- +# Nightly !!! success "GoReleaser Pro" The nightly build feature is a [GoReleaser Pro feature](/pro/). diff --git a/www/docs/customization/project.md b/www/docs/customization/project.md index 76d1516a0..3954235c1 100644 --- a/www/docs/customization/project.md +++ b/www/docs/customization/project.md @@ -1,6 +1,4 @@ ---- -title: Project Name ---- +# Project Name The project name is used in the name of the Brew formula, archives, etc. If none is given, it will be inferred from the name of the GitHub, GitLab, or diff --git a/www/docs/customization/publishers.md b/www/docs/customization/publishers.md index bd69813e9..7f3325d52 100644 --- a/www/docs/customization/publishers.md +++ b/www/docs/customization/publishers.md @@ -1,6 +1,4 @@ ---- -title: Custom Publishers ---- +# Custom Publishers GoReleaser supports publishing artifacts by executing a custom publisher. diff --git a/www/docs/customization/release.md b/www/docs/customization/release.md index 2aac39696..a250693b8 100644 --- a/www/docs/customization/release.md +++ b/www/docs/customization/release.md @@ -1,6 +1,4 @@ ---- -title: Release ---- +# Release GoReleaser can create a GitHub/GitLab/Gitea release with the current tag, upload all the artifacts and generate the changelog based on the new commits since the diff --git a/www/docs/customization/scoop.md b/www/docs/customization/scoop.md index 187e88592..85bdb432d 100644 --- a/www/docs/customization/scoop.md +++ b/www/docs/customization/scoop.md @@ -1,6 +1,4 @@ ---- -title: Scoop Manifests ---- +# Scoop Manifests After releasing to GitHub or GitLab, GoReleaser can generate and publish a _Scoop App Manifest_ into a repository that you have access to. diff --git a/www/docs/customization/sign.md b/www/docs/customization/sign.md index 44df8d739..fa0867cdb 100644 --- a/www/docs/customization/sign.md +++ b/www/docs/customization/sign.md @@ -1,6 +1,4 @@ ---- -title: Signing checksums and artifacts ---- +# Signing checksums and artifacts Signing ensures that the artifacts have been generated by yourself and your users can verify that by comparing the generated signature with your public diff --git a/www/docs/customization/snapcraft.md b/www/docs/customization/snapcraft.md index 7f2d3cca8..92ffc6f53 100644 --- a/www/docs/customization/snapcraft.md +++ b/www/docs/customization/snapcraft.md @@ -1,6 +1,4 @@ ---- -title: Snapcraft Packages (snaps) ---- +# Snapcraft Packages (snaps) GoReleaser can also generate `snap` packages. [Snaps](http://snapcraft.io/) are a new packaging format, that will let you diff --git a/www/docs/customization/snapshots.md b/www/docs/customization/snapshots.md index 2df064687..62b35e296 100644 --- a/www/docs/customization/snapshots.md +++ b/www/docs/customization/snapshots.md @@ -1,6 +1,4 @@ ---- -title: Snapshots ---- +# Snapshots Sometimes we want to generate a full build of our project, but neither want to validate anything nor upload it to anywhere. diff --git a/www/docs/customization/source.md b/www/docs/customization/source.md index 9d772969c..24f539e87 100644 --- a/www/docs/customization/source.md +++ b/www/docs/customization/source.md @@ -1,6 +1,4 @@ ---- -title: Source Archive ---- +# Source Archive You may add the current tag source archive to the release as well. This is particularly useful if you want to sign it, for example. diff --git a/www/docs/customization/templates.md b/www/docs/customization/templates.md index 1b8a735ac..a8f29c950 100644 --- a/www/docs/customization/templates.md +++ b/www/docs/customization/templates.md @@ -1,6 +1,4 @@ ---- -title: Name Templates ---- +# Name Templates Several fields in GoReleaser's config file support templating. diff --git a/www/docs/customization/universalbinaries.md b/www/docs/customization/universalbinaries.md index 358cbeeb6..ad8acc7bf 100644 --- a/www/docs/customization/universalbinaries.md +++ b/www/docs/customization/universalbinaries.md @@ -1,6 +1,4 @@ ---- -title: macOS Universal Binaries ---- +# macOS Universal Binaries GoReleaser can create _macOS Universal Binaries_ - also known as _Fat Binaries_. Those binaries are in a special format that contains both `arm64` and `amd64` executables in a single file. diff --git a/www/docs/customization/upload.md b/www/docs/customization/upload.md index 6bc9ae950..3f37b9896 100644 --- a/www/docs/customization/upload.md +++ b/www/docs/customization/upload.md @@ -1,6 +1,4 @@ ---- -title: HTTP Upload ---- +# HTTP Upload GoReleaser supports building and pushing artifacts to HTTP servers using simple HTTP requests. diff --git a/www/docs/deprecations.md b/www/docs/deprecations.md index 9ad810288..63549a882 100644 --- a/www/docs/deprecations.md +++ b/www/docs/deprecations.md @@ -1,6 +1,4 @@ ---- -title: Deprecation notices ---- +# Deprecation notices This page is used to list deprecation notices across GoReleaser. diff --git a/www/docs/limitations/cgo.md b/www/docs/limitations/cgo.md index 121dd91b3..f86e05841 100644 --- a/www/docs/limitations/cgo.md +++ b/www/docs/limitations/cgo.md @@ -1,6 +1,4 @@ ---- -title: CGO ---- +# 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. diff --git a/www/docs/limitations/semver.md b/www/docs/limitations/semver.md index 8e1607486..23fa7c67f 100644 --- a/www/docs/limitations/semver.md +++ b/www/docs/limitations/semver.md @@ -1,6 +1,4 @@ ---- -title: Semantic Versioning ---- +# Semantic Versioning GoReleaser enforces semantic versioning and will error on non compliant tags. diff --git a/www/docs/links.md b/www/docs/links.md index 774ec3202..9ab5da0f1 100644 --- a/www/docs/links.md +++ b/www/docs/links.md @@ -1,6 +1,4 @@ ---- -title: Links ---- +# Links - Follow the progress on the [GitHub repository](https://github.com/goreleaser/goreleaser) - Follow [@goreleaser](https://twitter.com/goreleaser) on Twitter for updates diff --git a/www/docs/sponsors.md b/www/docs/sponsors.md index 6eb7e8349..ade12fea6 100644 --- a/www/docs/sponsors.md +++ b/www/docs/sponsors.md @@ -1,6 +1,4 @@ ---- -title: Sponsors ---- +# Sponsors Does you or your company use GoReleaser? You can help keep the project bug-free and feature rich by sponsoring the project and the maintainers.