From 1f5f87c0f48a598906e5dd6baf188cbe226f6dbd Mon Sep 17 00:00:00 2001 From: snoyberg Date: Tue, 2 Dec 2014 06:34:21 -0800 Subject: [PATCH] Document slug limitations --- Experimental-package-releases-via-Stackage-Server.md | 1 + 1 file changed, 1 insertion(+) diff --git a/Experimental-package-releases-via-Stackage-Server.md b/Experimental-package-releases-via-Stackage-Server.md index 7f6e45c..7786b53 100644 --- a/Experimental-package-releases-via-Stackage-Server.md +++ b/Experimental-package-releases-via-Stackage-Server.md @@ -42,6 +42,7 @@ files recognized: * `desc` gives the human-readable title and description for the snapshot. Put the title on the first line, and the description on the following lines. (Note that, currently, we *only* display the title on the site, though we may add the description to the display in the future.) * `slug` is a recommendation for the short name of the snapshot. For example, the [most recent GHC 7.8 snapshot](http://www.stackage.org/snapshot/2014-11-26-ghc78-exc) as I write this is `http://www.stackage.org/snapshot/2014-11-26-ghc78-exc`, which has a slug of `2014-11-26-ghc78-exc`. Slugs must be globally unique, so if someone else has already taken that slug, Stackage Server will append a randomized token to the end. + * Note: slugs have a minimum length of three characters, and a maximum length of thirty characters, and consist of alphanumerics, dashes and underscores. * `hackage` is a list of all the package/version combos to be included in this snapshot from Hackage. For example, you might have: