Skip to content

Commit

Permalink
Adding v2.0.0 documenetation
Browse files Browse the repository at this point in the history
  • Loading branch information
amarouane committed Mar 29, 2021
1 parent 78124da commit b43c824
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
# Overview
DMR++ files generator is a cloud based activity that generate DMRPP files from netCDF4 and HDF files
## 📖 Documentation
- Release note [v2.0.0](https://ghrcdaac.github.io/dmrpp-generator/).
- Release note [v1.1.0](https://ghrcdaac.github.io/dmrpp-generator/).
- Release note [v1.0.6](https://ghrcdaac.github.io/dmrpp-generator/).
- Release note [v1.0.5](https://ghrcdaac.github.io/dmrpp-generator/).
Expand Down
37 changes: 36 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@ docker_image = "ghrcdaac/dmrpp-generator:v2.0.0"
```

## Features added to v2.0.0
Now you can add DMRPP options via collection definition
Now you can pass DMRPP options via collection definition.
For more info about DMRPP options please refer to [DMRPP Documentation](https://docs.google.com/presentation/d/1ZTeWjk6bUBgKP5iD2NVb_Ur8ZcvOpVbfd7pAl8c5bCs/edit#slide=id.p)

```code
{
"name" : "foo"
Expand All @@ -54,7 +56,40 @@ Now you can add DMRPP options via collection definition
...
}
```
`create_missing_cf` is an arbitrary key name, you can achieve the same result by passing
```code
{
"name" : "foo"
...
"meta": {
"dmrpp": {
"option1" : "-M"
}
...
}
...
}
```
For more supported DMRPP options (example `-v`)
```code
```code
{
"name" : "foo"
...
"meta": {
"dmrpp": {
"option1" : "-M",
"option2" : "-v"
}
...
}
...
}
```


## 🚨 Breaking Changes v2.0.0
DMRPP activity is using `url_path` instead of `filepath`.

## 🏃 Migration Steps to v1.1.0
Change the source url in your terraform file to point to v1.1.0 release
Expand Down

0 comments on commit b43c824

Please sign in to comment.