docs/choosealicense.com
docs/choosealicense.com
1
0
Fork 0
mirror of https://github.com/github/choosealicense.com synced 2024-12-22 12:50:24 +01:00
Code Issues Releases Wiki Activity

Update descriptions of fields to reflect hidden default change,

Browse Source 
info provided in
https://github.com/github/choosealicense.com/issues/290#issuecomment-138722623
This commit is contained in:
Mike Linksvayer 2016-02-02 13:45:39 -08:00
parent 64c286edd2
commit 86645a03b3
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -50,13 +50,13 @@ Licenses sit in the `/_licenses` folder. Each license has YAML front matter desc
* `note` - Additional information about the licenses * `note` - Additional information about the licenses
* `using` - A list of notable projects using the license in the form of `project_name: "url"` * `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) * `hidden` - Whether the license is hidden from the license list (defaults to true)
* `redirect_from` - Relative path(s) to redirect to the license from * `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) * `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 * `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 (e.g., GPL) * `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`) * `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 ### Auto-populated fields

10
_data/meta.yml
View File

@ -40,11 +40,11 @@
required: false required: false
- name: hidden - 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 required: false
- name: redirect_from - 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 required: false
- name: featured - name: featured
@ -52,11 +52,11 @@
required: false required: false
- name: nickname - 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 required: false
- name: variant - 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 required: false
- name: family - name: family
@ -64,5 +64,5 @@
required: false required: false
- name: tab-slug - 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 required: false