From 86645a03b3562191ee027d55d614e6951c60694a Mon Sep 17 00:00:00 2001 From: Mike Linksvayer Date: Tue, 2 Feb 2016 13:45:39 -0800 Subject: [PATCH] Update descriptions of fields to reflect hidden default change, info provided in https://github.com/github/choosealicense.com/issues/290#issuecomment-138722623 --- README.md | 10 +++++----- _data/meta.yml | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 27939f0..81d50ac 100644 --- a/README.md +++ b/README.md @@ -50,13 +50,13 @@ Licenses sit in the `/_licenses` folder. Each license has YAML front matter desc * `note` - Additional information about the licenses * `using` - A list of notable projects using the license in the form of `project_name: "url"` -* `hidden` - Whether the license is hidden from the license list (defaults to false) -* `redirect_from` - Relative path(s) to redirect to the license from +* `hidden` - Whether the license is hidden from the license list (defaults to true) +* `redirect_from` - Relative path(s) to redirect to the license from, to prevent breaking old URLs * `featured` - Whether the license should be featured on the main page (defaults to false) -* `nickname` - A shorter, human-readable license name where the SPDX license name is long -* `variant` - Whether the license is a variant of a family of licenses (e.g., GPL) +* `nickname` - A shorter, human-readable license name where the SPDX license name (`title` above) is long +* `variant` - Whether the license is a variant of a family of licenses (defaults to false) * `family` - If part of a license family, the name of the license family (e.g., `GPL`) -* `tab-slug` - If part of a license family, a license slug containing only `a-z`, `0-9`, and `_` characters +* `tab-slug` - If part of a license family, a license slug containing only `a-z`, `0-9`, and `_` characters, used for internal links on the licenses page ### Auto-populated fields diff --git a/_data/meta.yml b/_data/meta.yml index f146cfc..b9f2ed9 100644 --- a/_data/meta.yml +++ b/_data/meta.yml @@ -40,11 +40,11 @@ required: false - name: hidden - description: Whether the license is hidden from the license list (defaults to false) + description: Whether the license is hidden from the license list (defaults to true) required: false - name: redirect_from - description: Relative path(s) to redirect to the license from + description: Relative path(s) to redirect to the license from, to prevent breaking old URLs required: false - name: featured @@ -52,11 +52,11 @@ required: false - name: nickname - description: A shorter, human-readable license name where the SPDX license name is long + description: A shorter, human-readable license name where the SPDX license name (`title` above) is long required: false - name: variant - description: Whether the license is a variant of a family of licenses (e.g., GPL) + description: Whether the license is a variant of a family of licenses (defaults to false) required: false - name: family @@ -64,5 +64,5 @@ required: false - name: tab-slug - description: If part of a license family, a license slug containing only `a-z`, `0-9`, and `_` characters + description: If part of a license family, a license slug containing only `a-z`, `0-9`, and `_` characters, used for internal links on the licenses page required: false