Skip to content

Commit f81324f

Browse files
authored
Merge pull request #1113 from radiantearth/dev
Dev to master for 1.0.0-rc.3 release
2 parents ebd1675 + 2f0a35a commit f81324f

40 files changed

+1026
-434
lines changed

.circleci/rc.yaml

+9-12
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,15 @@ plugins:
44
# Apply some recommended defaults for consistency
55
- remark-preset-lint-consistent
66
- remark-preset-lint-recommended
7-
# No HTML for security - can't activate yet due to STAC logo in README.md
8-
# - lint-no-html
7+
- lint-no-html
98
# General formatting
10-
# - - remark-lint-emphasis-marker
11-
# - '*'
9+
- - remark-lint-emphasis-marker
10+
- '*'
1211
- remark-lint-hard-break-spaces
1312
- remark-lint-blockquote-indentation
1413
- remark-lint-no-consecutive-blank-lines
15-
# Detect overly long lines - be liberal for now and don't restrict to 80 yet
16-
# - - remark-lint-maximum-line-length
17-
# - 150
14+
- - remark-lint-maximum-line-length
15+
- 150
1816
# Code
1917
- remark-lint-fenced-code-flag
2018
- remark-lint-fenced-code-marker
@@ -23,24 +21,23 @@ plugins:
2321
- 'fenced'
2422
# Headings
2523
- remark-lint-heading-increment
26-
- remark-lint-no-duplicate-headings
2724
- remark-lint-no-multiple-toplevel-headings
2825
- remark-lint-no-heading-punctuation
2926
- - remark-lint-maximum-heading-length
3027
- 70
3128
- - remark-lint-heading-style
3229
- atx
30+
- - remark-lint-no-shortcut-reference-link
31+
- false
3332
# Lists
3433
- remark-lint-list-item-bullet-indent
3534
- remark-lint-ordered-list-marker-style
3635
- remark-lint-ordered-list-marker-value
3736
- remark-lint-checkbox-character-style
38-
# - - remark-lint-unordered-list-marker-style
39-
# - '-'
37+
- - remark-lint-unordered-list-marker-style
38+
- '-'
4039
- - remark-lint-list-item-indent
4140
- space
4241
# Tables
4342
- remark-lint-table-pipes
44-
# - remark-lint-table-pipe-alignment # Wait for https://github.com/remarkjs/remark-lint/issues/226
45-
# Urls
4643
- remark-lint-no-literal-urls

.github/pull_request_template.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,7 @@
1010

1111
- [ ] This PR is made against the dev branch (all proposed changes except releases should be against dev, not master).
1212
- [ ] This PR has **no** breaking changes.
13-
- [ ] I have added my changes to the [CHANGELOG](https://github.com/radiantearth/stac-spec/blob/dev/CHANGELOG.md) **or** a CHANGELOG entry is not required.
14-
- [ ] This PR affects the [STAC API spec](https://github.com/radiantearth/stac-api-spec), and I have opened issue/PR #XXX to track the change.
13+
- [ ] I have added my changes to the [CHANGELOG](https://github.com/radiantearth/stac-spec/blob/dev/CHANGELOG.md)
14+
**or** a CHANGELOG entry is not required.
15+
- [ ] This PR affects the [STAC API spec](https://github.com/radiantearth/stac-api-spec),
16+
and I have opened issue/PR #XXX to track the change.

.remarkignore

-1
This file was deleted.

CHANGELOG.md

+68-46
Large diffs are not rendered by default.

CODE_OF_CONDUCT.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ appearance, race, religion, or sexual identity and orientation.
1414
Examples of behavior that contributes to creating a positive environment
1515
include:
1616

17-
* Using welcoming and inclusive language
18-
* Being respectful of differing viewpoints and experiences
19-
* Gracefully accepting constructive criticism
20-
* Focusing on what is best for the community
21-
* Showing empathy towards other community members
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
2222

2323
Examples of unacceptable behavior by participants include:
2424

25-
* The use of sexualized language or imagery and unwelcome sexual attention or
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
2626
advances
27-
* Trolling, insulting/derogatory comments, and personal or political attacks
28-
* Public or private harassment
29-
* Publishing others' private information, such as a physical or electronic
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
3030
address, without explicit permission
31-
* Other conduct which could reasonably be considered inappropriate in a
31+
- Other conduct which could reasonably be considered inappropriate in a
3232
professional setting
3333

3434
## Our Responsibilities

CONTRIBUTING.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -24,28 +24,30 @@ require you to switch from the default of 'master', which we keep so it displays
2424
Creating a Pull Request will show our PR template, which includes checkbox reminders for a number
2525
of things.
2626

27-
* Adding an entry the [CHANGELOG](CHANGELOG.md). If the change is more editorial and minor then this
27+
- Adding an entry the [CHANGELOG](CHANGELOG.md). If the change is more editorial and minor then this
2828
is not required, but any change to the actual specification should definitely have one.
29-
* Base the PR against dev, as mentioned above - even if the branch was made off of dev this reminds
29+
- Base the PR against dev, as mentioned above - even if the branch was made off of dev this reminds
3030
you to change the base in GitHub's PR creation page.
31-
* Make a ticket in the STAC API repo if anything here affects there.
32-
* Highlight if the PR makes breaking changes to the specification (in beta there can still be
31+
- Make a ticket in the STAC API repo if anything here affects there.
32+
- Highlight if the PR makes breaking changes to the specification (in beta there can still be
3333
select breaking changes, but after 1.0 this will change)
3434

3535
All pull requests should submit clean markdown, which is checked by the continuous integration
3636
system. Please use `npm run check` locally, as described in the [next section](#check-files),
3737
to ensure that the checks on the pull request succeed. If it does not then you can look at the
3838
mistakes online, which are the same as running `npm run check` locally would surface.
3939

40-
All pull requests that modify or create JSON schema files or examples should use [JSON formatter](https://jsonformatter.org/) to keep files consistent across the repo.
40+
All pull requests that modify or create JSON schema files or examples should use
41+
[JSON formatter](https://jsonformatter.org/) to keep files consistent across the repo.
4142

4243
All pull requests additionally require a review of two STAC core team members. Releases are cut
4344
from dev to master (and require 3 approvals), see the [process](process.md) document for more details.
4445

4546
### Check files
4647

4748
The same check-markdown and check-examples programs that runs as a check on PR's is part of the repo and can be run locally.
48-
To install you'll need npm, which is a standard part of any [node.js installation](https://nodejs.org/en/download/). Alternatively, you can also use [yarn](https://yarnpkg.com/) instead of npm. In this case replace all occurrences of `npm` with `yarn` below.
49+
To install you'll need npm, which is a standard part of any [node.js installation](https://nodejs.org/en/download/).
50+
Alternatively, you can also use [yarn](https://yarnpkg.com/) instead of npm. In this case replace all occurrences of `npm` with `yarn` below.
4951

5052
First you'll need to install everything with npm once. Just navigate to the root of the stac-spec repo and on
5153
your command line run:

README.md

+19-17
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!--lint disable no-html-->
12
<img src="https://github.com/radiantearth/stac-site/raw/master/images/logo/stac-030-long.png" alt="stac-logo" width="700"/>
23

34
[![CircleCI](https://circleci.com/gh/radiantearth/stac-spec.svg?style=svg)](https://circleci.com/gh/radiantearth/stac-spec)
@@ -83,23 +84,24 @@ that enable clients to search for Item objects that match their filtering criter
8384
The **Item**, **Catalog**, **Collection**, and **STAC API** specifications are intended to be
8485
used together, but are designed so each piece is small, self-contained, and reusable in other contexts.
8586

86-
* **[Overview](overview.md)** describes the three core object type specifications and how they relate to one another.
87-
* **[Item Specification](item-spec/)** defines a STAC **Item**, which is a [GeoJSON](http://geojson.org) **Feature**
88-
with additional fields ("foreign members") for attributes like time and links to related entities and assets
89-
(including thumbnails). This is the core entity that describes the data to be discovered.
90-
* **[Catalog Specification](catalog-spec/)** specifies a structure to link various STAC Items together to be crawled or browsed. It is a
91-
simple, flexible JSON file of links to Items, Catalogs or Collections that can be used in a variety of ways.
92-
* **[Collection Specification](collection-spec/)** provides additional information about a spatio-temporal collection of data.
93-
In the context of STAC it is most likely a related group of STAC Items that is made available by a data provider.
94-
It includes things like the spatial and temporal extent of the data, the license, keywords, etc.
95-
It enables discovery at a higher level than individual Item objects, providing a simple way to describe sets of data.
96-
* **[Examples](examples/):** The *[examples/](examples/)* folder contains examples for all three specifications, linked together to form two
97-
complete examples. Each spec and extension links in to highlight particular files that demonstrate key concepts.
98-
* **[Extensions](extensions/README.md)** describe how STAC can use extensions that extend the functionality of the core spec or
99-
add fields for specific domains. Extensions can be published anywhere, although the preferred location for public extensions is in the [GitHub `stac-extensions` organization](https://github.com/stac-extensions).
100-
* **Additional documents:** The supporting documents include a complementary [best practices](best-practices.md)
101-
document, and information on contributing (links in the next section). We also maintain a [changelog](CHANGELOG.md) of
102-
what was modified in each version.
87+
- **[Overview](overview.md)** describes the three core object type specifications and how they relate to one another.
88+
- **[Item Specification](item-spec/)** defines a STAC **Item**, which is a [GeoJSON](http://geojson.org) **Feature**
89+
with additional fields ("foreign members") for attributes like time and links to related entities and assets
90+
(including thumbnails). This is the core entity that describes the data to be discovered.
91+
- **[Catalog Specification](catalog-spec/)** specifies a structure to link various STAC Items together to be crawled or browsed. It is a
92+
simple, flexible JSON file of links to Items, Catalogs or Collections that can be used in a variety of ways.
93+
- **[Collection Specification](collection-spec/)** provides additional information about a spatio-temporal collection of data.
94+
In the context of STAC it is most likely a related group of STAC Items that is made available by a data provider.
95+
It includes things like the spatial and temporal extent of the data, the license, keywords, etc.
96+
It enables discovery at a higher level than individual Item objects, providing a simple way to describe sets of data.
97+
- **[Examples](examples/):** The *[examples/](examples/)* folder contains examples for all three specifications, linked together to form two
98+
complete examples. Each spec and extension links in to highlight particular files that demonstrate key concepts.
99+
- **[Extensions](extensions/README.md)** describe how STAC can use extensions that extend the functionality of the core spec or
100+
add fields for specific domains. Extensions can be published anywhere,
101+
although the preferred location for public extensions is in the [GitHub `stac-extensions` organization](https://github.com/stac-extensions).
102+
- **Additional documents:** The supporting documents include a complementary [best practices](best-practices.md)
103+
document, and information on contributing (links in the next section). We also maintain a [changelog](CHANGELOG.md) of
104+
what was modified in each version.
103105

104106
## Contributing
105107

0 commit comments

Comments
 (0)