Merge pull request #1067 from twpayne/release-v2

Update documentation and release process for v2 release

.goreleaser.yaml

@@ -146,7 +146,6 @@ nfpms:
   bindir: /usr/bin
 
 release:
-  prerelease: true
 
 scoop:
   bucket:
@@ -166,7 +165,7 @@ snapcrafts:
   summary: "Manage your dotfiles across multiple diverse machines, securely."
   description: "Manage your dotfiles across multiple diverse machines, securely."
   publish: true
-  grade: devel
+  grade: stable
   confinement: classic
   apps:
     chezmoi:

README.md

@@ -4,7 +4,6 @@
 
 Manage your dotfiles across multiple diverse machines, securely.
 
-* [Go to chezmoi.io](#go-to-chezmoiio)
 * [How do I start with chezmoi now?](#how-do-i-start-with-chezmoi-now)
 * [What does chezmoi do and why should I use it?](#what-does-chezmoi-do-and-why-should-i-use-it)
 * [What are chezmoi's key features?](#what-are-chezmois-key-features)
@@ -20,12 +19,6 @@ Manage your dotfiles across multiple diverse machines, securely.
 * [What documentation is available?](#what-documentation-is-available)
 * [License](#license)
 
-## Go to chezmoi.io
-
-You are looking at documentation for chezmoi version 2, which hasn't been
-released yet. Documentation for the current version of chezmoi is at
-[chezmoi.io](https://chezmoi.io/).
-
 ## How do I start with chezmoi now?
 
 [Install chezmoi](docs/INSTALL.md) then read the [quick start

docs/CHANGES.md

@@ -1,24 +1,39 @@
 # chezmoi Changes
 
 <!--- toc --->
-* [Go to chezmoi.io](#go-to-chezmoiio)
+* [Overview](#overview)
 * [Version 2](#version-2)
   * [New features in version 2](#new-features-in-version-2)
   * [Changes from version 1](#changes-from-version-1)
 
-## Go to chezmoi.io
+## Overview
 
-You are looking at documentation for chezmoi version 2, which hasn't been
-released yet. Documentation for the current version of chezmoi is at
-[chezmoi.io](https://chezmoi.io/docs/changes/).
+This document describes what's new in chezmoi v2 for chezmoi v1 users.
+
+If you're not using a dotfile manager, then read [why you should you use a
+dotfile
+manager](https://github.com/twpayne/chezmoi/blob/master/docs/COMPARISON.md#why-should-i-use-a-dotfile-manager)
+and then [install
+chezmoi](https://github.com/twpayne/chezmoi/blob/master/docs/INSTALL.md) and
+follow the [quick-start
+guide](https://github.com/twpayne/chezmoi/blob/master/docs/QUICKSTART.md).
+
+If you're already using a dotfile manager, but not chezmoi, then read about [how
+chezmoi compares to other dotfile
+managers](https://github.com/twpayne/chezmoi/blob/master/docs/COMPARISON.md)
+first and then [install
+chezmoi](https://github.com/twpayne/chezmoi/blob/master/docs/INSTALL.md), follow
+the [quick-start
+guide](https://github.com/twpayne/chezmoi/blob/master/docs/QUICKSTART.md), and
+read the [how-to
+guide](https://github.com/twpayne/chezmoi/blob/master/docs/HOWTO.md) to quickly
+discover chezmoi's functionality.
 
 ## Version 2
 
 chezmoi version 2 brings many new features and fixes a few corner-case bugs.
 Very few, if any, changes should be required to your source directory,
-templates, or config file. If you haven't used chezmoi before, then you should
-start with [chezmoi's
-README](https://github.com/twpayne/chezmoi/blob/master/README.md) instead.
+templates, or config file.
 
 ### New features in version 2
 

docs/COMPARISON.md

@@ -1,7 +1,6 @@
 # chezmoi Comparison guide
 
 <!--- toc --->
-* [Go to chezmoi.io](#go-to-chezmoiio)
 * [Comparison table](#comparison-table)
 * [Why should I use a dotfile manager?](#why-should-i-use-a-dotfile-manager)
 * [I already have a system to manage my dotfiles, why should I use chezmoi?](#i-already-have-a-system-to-manage-my-dotfiles-why-should-i-use-chezmoi)
@@ -10,12 +9,6 @@
   * [You have to maintain your own tool](#you-have-to-maintain-your-own-tool)
   * [Setting up your dotfiles requires more than two short commands](#setting-up-your-dotfiles-requires-more-than-two-short-commands)
 
-## Go to chezmoi.io
-
-You are looking at documentation for chezmoi version 2, which hasn't been
-released yet. Documentation for the current version of chezmoi is at
-[chezmoi.io](https://chezmoi.io/docs/comparison/).
-
 ## Comparison table
 
 [chezmoi]: https://chezmoi.io/

docs/FAQ.md

@@ -1,7 +1,6 @@
 # chezmoi Frequently Asked Questions
 
 <!--- toc --->
-* [Go to chezmoi.io](#go-to-chezmoiio)
 * [How can I quickly check for problems with chezmoi on my machine?](#how-can-i-quickly-check-for-problems-with-chezmoi-on-my-machine)
 * [What are the consequences of "bare" modifications to the target files? If my `.zshrc` is managed by chezmoi and I edit `~/.zshrc` without using `chezmoi edit`, what happens?](#what-are-the-consequences-of-bare-modifications-to-the-target-files-if-my-zshrc-is-managed-by-chezmoi-and-i-edit-zshrc-without-using-chezmoi-edit-what-happens)
 * [How can I tell what dotfiles in my home directory aren't managed by chezmoi? Is there an easy way to have chezmoi manage a subset of them?](#how-can-i-tell-what-dotfiles-in-my-home-directory-arent-managed-by-chezmoi-is-there-an-easy-way-to-have-chezmoi-manage-a-subset-of-them)
@@ -27,12 +26,6 @@
 * [Where do I ask a question that isn't answered here?](#where-do-i-ask-a-question-that-isnt-answered-here)
 * [I like chezmoi. How do I say thanks?](#i-like-chezmoi-how-do-i-say-thanks)
 
-## Go to chezmoi.io
-
-You are looking at documentation for chezmoi version 2, which hasn't been
-released yet. Documentation for the current version of chezmoi is at
-[chezmoi.io](https://chezmoi.io/docs/faq/).
-
 ## How can I quickly check for problems with chezmoi on my machine?
 
 Run:

docs/HOWTO.md

@@ -1,7 +1,6 @@
 # chezmoi How-To Guide
 
 <!--- toc --->
-* [Go to chezmoi.io](#go-to-chezmoiio)
 * [Daily operations](#daily-operations)
   * [Use a hosted repo to manage your dotfiles across multiple machines](#use-a-hosted-repo-to-manage-your-dotfiles-across-multiple-machines)
   * [Pull the latest changes from your repo and apply them](#pull-the-latest-changes-from-your-repo-and-apply-them)
@@ -40,12 +39,6 @@
   * [Migrate from a dotfile manager that uses symlinks](#migrate-from-a-dotfile-manager-that-uses-symlinks)
 * [Migrate away from chezmoi](#migrate-away-from-chezmoi)
 
-## Go to chezmoi.io
-
-You are looking at documentation for chezmoi version 2, which hasn't been
-released yet. Documentation for the current version of chezmoi is at
-[chezmoi.io](https://chezmoi.io/docs/how-to/).
-
 ## Daily operations
 
 ### Use a hosted repo to manage your dotfiles across multiple machines

docs/INSTALL.md

@@ -1,20 +1,13 @@
 # chezmoi Install Guide
 
 <!--- toc --->
-* [Go to chezmoi.io](#go-to-chezmoiio)
 * [One-line binary install](#one-line-binary-install)
 * [One-line package install](#one-line-package-install)
 * [Pre-built Linux packages](#pre-built-linux-packages)
 * [Pre-built binaries](#pre-built-binaries)
 * [All pre-built Linux packages and binaries](#all-pre-built-linux-packages-and-binaries)
 * [From source](#from-source)
 
-## Go to chezmoi.io
-
-You are looking at documentation for chezmoi version 2, which hasn't been
-released yet. Documentation for the current version of chezmoi is at
-[chezmoi.io](https://chezmoi.io/docs/install/).
-
 ## One-line binary install
 
 Install the correct binary for your operating system and architecture in `./bin`

docs/QUICKSTART.md

@@ -1,18 +1,11 @@
 # chezmoi Quick Start Guide
 
 <!--- toc --->
-* [Go to chezmoi.io](#go-to-chezmoiio)
 * [Concepts](#concepts)
 * [Start using chezmoi on your current machine](#start-using-chezmoi-on-your-current-machine)
 * [Using chezmoi across multiple machines](#using-chezmoi-across-multiple-machines)
 * [Next steps](#next-steps)
 
-## Go to chezmoi.io
-
-You are looking at documentation for chezmoi version 2, which hasn't been
-released yet. Documentation for the current version of chezmoi is at
-[chezmoi.io](https://chezmoi.io/docs/quickstart/).
-
 ## Concepts
 
 chezmoi stores the desired state of your dotfiles in the directory

docs/REFERENCE.md

@@ -3,7 +3,6 @@
 Manage your dotfiles securely across multiple machines.
 
 <!--- toc --->
-* [Go to chezmoi.io](#go-to-chezmoiio)
 * [Concepts](#concepts)
 * [Global command line flags](#global-command-line-flags)
   * [`--color` *value*](#--color-value)
@@ -110,12 +109,6 @@ Manage your dotfiles securely across multiple machines.
   * [`stat` *name*](#stat-name)
   * [`vault` *key*](#vault-key)
 
-## Go to chezmoi.io
-
-You are looking at documentation for chezmoi version 2, which hasn't been
-released yet. Documentation for the current version of chezmoi is at
-[chezmoi.io](https://chezmoi.io/docs/reference/).
-
 ## Concepts
 
 chezmoi evaluates the source state for the current machine and then updates the