Update documentation links and wording from wiki to 'doc/'

Author: borsboom

ChangeLog.md

@@ -95,7 +95,7 @@ Major changes:
 * Respect TemplateHaskell addDependentFile dependency changes ([#105](https://github.com/commercialhaskell/stack/issues/105))
     * TH dependent files are taken into account when determining whether a package needs to be built.
 * Overhauled target parsing, added `--test` and `--bench` options [#651](https://github.com/commercialhaskell/stack/issues/651)
-    * For details, see [Build commands Wiki page](https://github.com/commercialhaskell/stack/wiki/Build-command)
+    * For details, see [Build commands documentation](doc/build_command.md)
 
 Other enhancements:
 

doc/GUIDE.md

@@ -45,8 +45,8 @@ all commands work cross-platform, unless explicitly stated otherwise.
 
 ## Downloading and Installation
 
-The [wiki page dedicated to downloading
-stack](https://github.com/commercialhaskell/stack/wiki/Downloads) has the most
+The [documentation dedicated to downloading
+stack](install_and_upgrade.md) has the most
 up-to-date information for a variety of operating systems, including multiple
 GNU/Linux flavors. Instead of repeating that content here, please go check out
 that page and come back here when you can successfully run `stack --version`.
@@ -616,8 +616,8 @@ At the time of writing:
 * Experimental GHCJS support
 * Experimental custom snapshot support
 
-The most up-to-date information can always be found on the [stack.yaml wiki
-page](https://github.com/commercialhaskell/stack/wiki/stack.yaml#resolver).
+The most up-to-date information can always be found in the
+[stack.yaml documentation](yaml_configuration.md#resolver).
 
 ## Existing projects
 
@@ -722,9 +722,8 @@ Please choose one of the following commands to get started.
     stack init --resolver nightly-2015-08-26
     stack init --resolver lts-2.22
 
-You'll then need to add some extra-deps. See:
-
-    https://github.com/commercialhaskell/stack/wiki/stack.yaml#extra-deps
+You'll then need to add some extra-deps. See the
+[stack.yaml documentation](yaml_configuration.md#extra-deps).
 
 You can also try falling back to a dependency solver with:
 
@@ -1026,8 +1025,8 @@ to achieve a high level of flexibility in telling stack exactly what you want
 to build.
 
 We're not going to cover the full generality of these arguments here; instead,
-there's [a Wiki page covering the full build command
-syntax](https://github.com/commercialhaskell/stack/wiki/Build-command).
+there's [documentation covering the full build command
+syntax](build_command.md).
 Here, we'll just point out a few different types of arguments:
 
 * You can specify a *package name*, e.g. `stack build vector`.
@@ -1162,10 +1161,9 @@ Notice that multiple directories are listed in the `packages` key.
 
 In addition to local directories, you can also refer to packages available in a
 Git repository or in a tarball over HTTP/HTTPS. This can be useful for using a
-modified version of a dependency that hasn't yet been released upstream. This
-is a slightly more advanced usage that we won't go into detail with here, but
-it's covered in the [stack.yaml wiki
-page](https://github.com/commercialhaskell/stack/wiki/stack.yaml#packages).
+modified version of a dependency that hasn't yet been released upstream. This is
+a slightly more advanced usage that we won't go into detail with here, but it's
+covered in the [stack.yaml documentation](yaml_configuration.md#packages).
 
 ## Flags and GHC options
 
@@ -1252,8 +1250,8 @@ confusion.
 
 Final point: if you have GHC options that you'll be regularly passing to your
 packages, you can add them to your stack.yaml file (starting with
-stack-0.1.4.0). See [the wiki page section on
-ghc-options](https://github.com/commercialhaskell/stack/wiki/stack.yaml#ghc-options)
+stack-0.1.4.0). See [the documentation section on
+ghc-options](yaml_configuration.md#ghc-options)
 for more information.
 
 ## path
@@ -1513,8 +1511,8 @@ There are lots of resources available for learning more about stack:
 * `--verbose` (or `-v`) — much more info about internal operations (useful for bug reports)
 * The [README](https://github.com/commercialhaskell/stack#readme)
 * The [stack mailing list](https://groups.google.com/d/forum/haskell-stack)
-* The [stack wiki](https://github.com/commercialhaskell/stack/wiki),
-    * in particular [the FAQ page](https://github.com/commercialhaskell/stack/wiki/FAQ)
+* The [the FAQ](faq.md)
+* The [stack wiki](https://github.com/commercialhaskell/stack/wiki)
 * The [haskell-stack tag on Stack Overflow](http://stackoverflow.com/questions/tagged/haskell-stack)
 * [Another getting started with stack tutorial](http://seanhess.github.io/2015/08/04/practical-haskell-getting-started.html)
 * [Why is stack not cabal?](https://www.fpcomplete.com/blog/2015/06/why-is-stack-not-cabal)
@@ -1568,10 +1566,9 @@ getting type information in Emacs. For more information, see
 
 ### Visualizing dependencies
 
-If you'd like to get some insight into the dependency tree of your packages,
-you can use the `stack dot` command and Graphviz. More information is
-[available on the
-wiki](https://github.com/commercialhaskell/stack/wiki/Visualizing-dependencies-with-Graphviz).
+If you'd like to get some insight into the dependency tree of your packages, you
+can use the `stack dot` command and Graphviz. More information is
+[available in the Dependency visualization documentation](dependency_visualization.md).
 
 ### Travis with caching
 
@@ -1656,8 +1653,8 @@ code inside a Docker image, which means:
 * the Docker images ship with entire precompiled snapshots. That means you have
   a large initial download, but much faster builds
 
-For more information, see [the Docker wiki
-page](https://github.com/commercialhaskell/stack/wiki/Docker).
+For more information, see
+[the Docker-integration documentation](docker_integration.md).
 
 stack can also generate Docker images for you containing your built executables.
 This feature is great for automating deployments from CI. This feature is not

doc/faq.md

@@ -153,7 +153,7 @@ Like all other targets, `stack test` runs test suites in parallel by default. Th
 
 #### Can I get bash autocompletion?
 
-Yes, see the [Shell-autocompletion](https://github.com/commercialhaskell/stack/wiki/Shell-autocompletion) wiki entry
+Yes, see the [shell-autocompletion documentation](shell_autocompletion.md)
 
 #### How do I update my package index?
 
@@ -206,28 +206,7 @@ packages and the tools. See [Docker integration](docker_integration.md) for deta
 
 #### How do I use this with Travis CI?
 
-Stack is in beta now, so keep in mind that the tool's interface is still under flux. For early adopters, here's a sample `.travis.yaml` file:
-
-```YAML
-language: haskell
-
-before_install:
-  # Instructions taken from https://github.com/commercialhaskell/stack/wiki/Downloads
-  - wget -q -O- http://download.fpcomplete.com/ubuntu/fpco.key | sudo apt-key add -
-  - echo 'deb http://download.fpcomplete.com/ubuntu/precise stable main' | sudo tee /etc/apt/sources.list.d/fpco.list
-  - sudo apt-get update
-  - sudo apt-get install stack -y
-
-install:
-  - stack setup
-
-script:
-  - stack test
-```
-
-If you wish to use stack as part of a larger matrix, à la [hvr/multi-ghc-travis](https://github.com/hvr/multi-ghc-travis), then you need to do a bit more work. Take a look at [tebello-thejane/bitx-haskell/.travis.yml](https://github.com/tebello-thejane/bitx-haskell/blob/master/.travis.yml), and note the extensive use of `if` statements to select between building with Cabal and stack.
-
-Also, note that some `stack` commands have been known to take longer than 20 minutes when on Travis, thus causing Travis to kill the build. A cheap trick is to cause `stack` to display verbose output (with the `-v` option), which causes it to display more often and thus Travis is less likely to kill it due to lack of perceived activity.
+See the [Travis section in the GUIDE](GUIDE.md#travis-with-caching)
 
 #### What is licensing restrictions on Windows?
 

doc/shell_autocompletion.md

@@ -1,5 +1,9 @@
 ## Shell Autocompletion:
 
+Note: if you installed a package for you Linux distribution, the bash completion
+file was automatically installed (you may need the `bash-completion` package to
+have it take effect).
+
 The following adds support for shell tab completion for standard Stack arguments, although completion for filenames and executables etc. within stack is still lacking (see [issue 82](https://github.com/commercialhaskell/stack/issues/832)).
 
 ### for bash users
@@ -28,4 +32,4 @@ eval "$(stack --bash-completion-script "$(which stack)")"
 
 :information_source: If you already have quite a large zshrc, or if you use oh-my-zsh, **compinit** will probably already be loaded. If you have a blank zsh config, all of the 3 lines above are necessary.
 
-:gem: tip: instead of running those 3 lines from your shell every time you want to use stack, you can add those 3 lines in your $HOME/.zshrc file
+:gem: tip: instead of running those 3 lines from your shell every time you want to use stack, you can add those 3 lines in your $HOME/.zshrc file

doc/yaml_configuration.md

@@ -85,7 +85,7 @@ Specifies how dependencies are resolved. There are currently four resolver types
 * No snapshot, just use packages shipped with the compiler
     * For GHC this looks like `resolver: ghc-7.10.2`
     * For GHCJS this looks like `resolver: ghcjs-0.1.0_ghc-7.10.2`.
-* [Custom snapshot](/commercialhaskell/stack/wiki/Custom-Snapshot)
+* [Custom snapshot](https://github.com/commercialhaskell/stack/wiki/Custom-Snapshot)
 
 Each of these resolvers will also determine what constraints are placed on the compiler version. See the [compiler-check](#compiler-check) option for some additional control over compiler version.
 

etc/scripts/README.md

@@ -6,7 +6,7 @@ currently handles some tasks that need to be performed on each platform:
 building the release, running some pre-release checks, and uploading binaries to
 a Github release.
 
-See [Checklist](https://github.com/commercialhaskell/stack/wiki/Checklist) of
+See [Checklist](../../doc/MAINTAINER_GUIDE.md) of
 additional manual release steps.
 
 Prerequisites

src/Stack/Config.hs

@@ -372,7 +372,7 @@ resolvePackageEntry menv projRoot pe = do
             subs -> mapM (resolveDir entryRoot) subs
     case peValidWanted pe of
         Nothing -> return ()
-        Just _ -> $logWarn "Warning: you are using the deprecated valid-wanted field. You should instead use extra-dep. See: https://github.com/commercialhaskell/stack/wiki/stack.yaml#packages"
+        Just _ -> $logWarn "Warning: you are using the deprecated valid-wanted field. You should instead use extra-dep. See: https://github.com/commercialhaskell/stack/blob/master/doc/yaml_configuration.md#packages"
     return $ map (, not $ peExtraDep pe) paths
 
 -- | Resolve a PackageLocation into a path, downloading and cloning as

src/Stack/Init.hs

@@ -118,7 +118,7 @@ renderStackYaml p =
         _ -> assert False $ B.byteString $ Yaml.encode p
   where
     renderObject o =
-        B.byteString "# For more information, see: https://github.com/commercialhaskell/stack/wiki/stack.yaml\n\n" <>
+        B.byteString "# For more information, see: https://github.com/commercialhaskell/stack/blob/master/doc/yaml_configuration.md\n\n" <>
         F.foldMap (goComment o) comments <>
         goOthers (o `HM.difference` HM.fromList comments) <>
         B.byteString
@@ -170,7 +170,7 @@ getSnapshots' =
         $logError ""
         $logError "You can try again, or create your stack.yaml file by hand. See:"
         $logError ""
-        $logError "    https://github.com/commercialhaskell/stack/wiki/stack.yaml"
+        $logError "    https://github.com/commercialhaskell/stack/blob/master/doc/yaml_configuration.md"
         $logError ""
         $logError $ "Exception was: " <> T.pack (show e)
         return Nothing

src/Stack/Setup.hs

@@ -145,7 +145,7 @@ instance Show SetupException where
         [ "The GHC located at "
         , toFilePath ghc
         , " failed to compile a sanity check. Please see:\n\n"
-        , "    https://github.com/commercialhaskell/stack/wiki/Downloads\n\n"
+        , "    https://github.com/commercialhaskell/stack/blob/master/doc/install_and_upgrade.md\n\n"
         , "for more information. Exception was:\n"
         , show e
         ]

src/Stack/Types/Config.hs

@@ -719,7 +719,7 @@ instance Show ConfigException where
         , toFilePath configFile
         , "':\n"
         , show exception
-        , "\nSee https://github.com/commercialhaskell/stack/wiki/stack.yaml."
+        , "\nSee https://github.com/commercialhaskell/stack/blob/master/doc/yaml_configuration.md."
         ]
     show (ParseResolverException t) = concat
         [ "Invalid resolver value: "
@@ -757,7 +757,7 @@ instance Show ConfigException where
             (\name -> "    stack init --resolver " ++ T.unpack (renderSnapName name))
             names
         , "\nYou'll then need to add some extra-deps. See:\n\n"
-        , "    https://github.com/commercialhaskell/stack/wiki/stack.yaml#extra-deps"
+        , "    https://github.com/commercialhaskell/stack/blob/master/doc/yaml_configuration.md#extra-deps"
         , "\n\nYou can also try falling back to a dependency solver with:\n\n"
         , "    stack init --solver"
         ]