1
0
mirror of https://github.com/github/choosealicense.com synced 2024-12-22 04:40:09 +01:00
Mike Linksvayer 810eeb5618 rename/order license properties better reflect how licenses work
and are structured

grant (permissions)
conditioned on (conditions)
with limitations

Permissions coming first combats mistaken but apparently widespread
impression that licenses impose conditions, even such that without
a license, there would be no conditions/work would be in the public
domain.

Requirements->Conditions emphasizes that they are pertinent if one
wants to take advantage of permissions.

Forbiddens->Limitations is more accurate: in most cases licenses
don't give permission to hold licensors liable, in some cases to
use licensors' trademarks or patents, but a licensee does not lose
the permissions granted by the license if the licensee holds licensor
liable, etc. Also emphasizes that there are limitatations on the
license grant, not that the license imposes prohibitions.

The most concise place to see both the rename and reorder is in
_includes/license-overview.html

I did not reorder the appearance of the groups of properties in
license source files (.txt files in _licenses) as those orderings
are not used to render anything on the webiste. Might do so later.
2016-03-01 13:33:15 -08:00

65 lines
1.7 KiB
YAML

# Each license has YAML front matter describing the license's properties.
# The available fields are:
- name: title
description: The SPDX-compliant, human-readable license name
required: true
- name: source
description: The URL to the license source text
required: true
- name: description
description: A human-readable description of the license
required: true
- name: how
description: Instructions on how to implement the license
required: true
- name: conditions
description: Bulleted list of required rules
required: true
- name: permissions
description: Bulleted list of permitted rules
required: true
- name: limitations
description: Bulleted list of limited rules
required: true
# Optional fields
- name: note
description: Additional information about the licenses
required: false
- name: using
description: 'A list of notable projects using the license in the form of `project_name: "url"`'
required: false
- name: hidden
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, to prevent breaking old URLs
required: false
- name: featured
description: Whether the license should be featured on the main page (defaults to false)
required: false
- name: nickname
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 (defaults to false)
required: false
- name: family
description: If part of a license family, the name of the license family (e.g., `GPL`)
required: false