Skip to content

Commit ca48c1e

Browse files
committed
Markdown fixes
1 parent 6be01d1 commit ca48c1e

File tree

2 files changed

+21
-14
lines changed

2 files changed

+21
-14
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Changelog
2+
23
All notable changes to this project will be documented in this file.
34

45
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@@ -32,7 +33,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
3233
## [v1.0.0] - 2021-03-04
3334

3435
### Added
36+
3537
- Best practices and asset roles
3638

39+
[Unreleased]: <https://github.com/stac-extensions/sar/compare/v1.1.0...main>
3740
[v1.1.0]: <https://github.com/stac-extensions/sar/compare/v1.0.0...v1.1.0>
3841
[v1.0.0]: <https://github.com/stac-extensions/sar/tree/v1.0.0>

README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@
1111
This document explains the fields of the Synthetic-Aperture Radar (SAR) Extension to the
1212
[SpatioTemporal Asset Catalog](https://github.com/radiantearth/stac-spec) (STAC) specification.
1313

14-
SAR data is considered to be data that represents a snapshot of the earth for a single date and time taken by a synthetic-aperture radar system
14+
SAR data is considered to be data that represents a snapshot of the earth for a single date and time taken by a synthetic-aperture radar system
1515
such as Sentinel-1, RADARSAT or EnviSAT.
1616

17-
If the data has been collected by a satellite, it is strongly recommended to use the
18-
[`sat` extension](https://github.com/stac-extensions/sat).
19-
If the data has been collected on an airborne platform it is strongly recommended to use the
17+
If the data has been collected by a satellite, it is strongly recommended to use the
18+
[`sat` extension](https://github.com/stac-extensions/sat).
19+
If the data has been collected on an airborne platform it is strongly recommended to use the
2020
[Instrument Fields](https://github.com/radiantearth/stac-spec/blob/master/item-spec/common-metadata.md#instrument).
2121

2222
To describe frame start and end times, use the
@@ -50,7 +50,7 @@ To describe frame start and end times, use the
5050
| sar:relative_burst | number | Identification number that uniquely identifies a burst cycle within each repeat cycle. |
5151
| sar:beam_ids | \[string] | Composition of the swath of the SAR acquision referencing the beam identifiers. |
5252

53-
**Note:** In this specification *range* values are meant to be measured perpendicular to the flight path and *azimuth* values
53+
**Note:** In this specification *range* values are meant to be measured perpendicular to the flight path and *azimuth* values
5454
are meant to be measured parallel to the flight path.
5555

5656
### Additional Field Information
@@ -62,13 +62,13 @@ Specifies a single polarization or a polarization combination. For single polari
6262
For dual polarized radars and alternating polarization, add the corresponding polarizations to the array.
6363
For instance, for `HH+HV`, add both `HH` and `HV`.
6464

65-
**Important:** In the `properties` of a STAC Item `sar:polarizations` must be a set with unique elements.
65+
**Important:** In the `properties` of a STAC Item `sar:polarizations` must be a set with unique elements.
6666
In assets `sar:polarizations` can contain duplicate elements and, if possible, the polarizations must appear in the same order as in the file.
6767

6868
#### sar:beam_ids
6969

7070
The `sar:beam_ids` field is used to reference the beam identifiers of the SAR acquisition. According to the mission and the sensor mode,
71-
the beam identifiers can be used to identify the composition of the swath of the SAR acquisition.
71+
the beam identifiers can be used to identify the composition of the swath of the SAR acquisition.
7272
The beam identifiers are usually provided in the metadata of the SAR data.
7373

7474
### Common Frequency Band Names
@@ -104,12 +104,13 @@ A list of suggestions for [`product:type`](https://github.com/stac-extensions/pr
104104
| SLC | complex | Single-look Ground projected Complex image (used by Sentinel-1) |
105105

106106
This can vary by data provider, who all may use slightly different names.
107-
Sentinel-1 for instance uses `GRD`, which is the same as the more general `MGD` and `SLC` instead of `SGC`.
107+
Sentinel-1 for instance uses `GRD`, which is the same as the more general `MGD` and `SLC` instead of `SGC`.
108108

109-
**Note:**
110-
- v1.0 of the extension did require `sar:product_type`.
111-
- v1.1 deprecates `sar:product_type` and it's not required any longer, but `product:type` is **strongly recommended**.
112-
- v2.0 will require `product:type` as part of this extension and remove `sar:product_type`.
109+
> [!NOTE]
110+
>
111+
> - v1.0 of the extension did require `sar:product_type`.
112+
> - v1.1 deprecates `sar:product_type` and it's not required any longer, but `product:type` is **strongly recommended**.
113+
> - v2.0 will require `product:type` as part of this extension and remove `sar:product_type`.
113114
114115
### Date and Time
115116

@@ -147,23 +148,26 @@ for running tests are copied here for convenience.
147148

148149
### Running tests
149150

150-
The same checks that run as checks on PR's are part of the repository and can be run locally to verify that changes are valid.
151+
The same checks that run as checks on PR's are part of the repository and can be run locally to verify that changes are valid.
151152
To run tests locally, you'll need `npm`, which is a standard part of any [node.js installation](https://nodejs.org/en/download/).
152153

153-
First you'll need to install everything with npm once. Just navigate to the root of this repository and on
154+
First you'll need to install everything with npm once. Just navigate to the root of this repository and on
154155
your command line run:
156+
155157
```bash
156158
npm install
157159
```
158160

159161
Then to check markdown formatting and test the examples against the JSON schema, you can run:
162+
160163
```bash
161164
npm test
162165
```
163166

164167
This will spit out the same texts that you see online, and you can then go and fix your markdown or examples.
165168

166169
If the tests reveal formatting problems with the examples, you can fix them with:
170+
167171
```bash
168172
npm run format-examples
169173
```

0 commit comments

Comments
 (0)