Skip to content

Commit

Permalink
Merge pull request #194 from OpenEnergyPlatform/feature-189-year
Browse files Browse the repository at this point in the history 
Add year to section sources #189
  • Loading branch information
@Ludee
Ludee authored Oct 29, 2024
2 parents 1578fb0 + 5d2d7c3 commit 2101ae5
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 8 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ Here is a template for new release sections
- Add basic documentation with MKdocs [(#184)](https://github.com/OpenEnergyPlatform/oemetadata/pull/184)
- Add key 'publisher' to section 'context' [(#191)](https://github.com/OpenEnergyPlatform/oemetadata/pull/191)
- Add an array 'authors' in section 'sources'. [(#193)](https://github.com/OpenEnergyPlatform/oemetadata/pull/193)
- Add year to section sources [(#194)](https://github.com/OpenEnergyPlatform/oemetadata/pull/194)
- Add a key description to collection and update badges [(#195)](https://github.com/OpenEnergyPlatform/oemetadata/pull/195)

### Changed
Expand Down
10 changes: 10 additions & 0 deletions metadata/v20/build_source/schemas/sources.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,16 @@
"badge": "Bronze",
"title": "Source Description"
},
"publicationYear": {
"description": "Indicates the year when the work was published.",
"example": "2023",
"type": [
"string",
"null"
],
"badge": "Bronze",
"title": "Publication Year"
},
"path": {
"description": "A URL to the original source.",
"example": "https://www.ipcc.ch/report/ar6/syr/downloads/report/IPCC_AR6_SYR_FullVolume.pdf",
Expand Down
17 changes: 9 additions & 8 deletions metadata/v20/metadata_key_description.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,14 +119,15 @@ If a value is not yet available, use: 'ToDo'.
| 1.1 | title | A human readable title of the source, a document title or organisation name. | IPCC Sixth Assessment Report (AR6) - Climate Change 2023 - Synthesis Report | Bronze |
| 1.2 | authors | An array of the full names of the authors of the source material. | Hoesung Lee,José Romero, The Core Writing Team | Bronze |
| 1.3 | description | A free text description of the source. | A Report of the Intergovernmental Panel on Climate Change | Bronze |
| 1.4 | path | A URL to the original source. | https://www.ipcc.ch/report/ar6/syr/downloads/report/IPCC_AR6_SYR_FullVolume.pdf | Bronze |
| 1.5 | **licenses** | An array of objects of licenses under which the described source is provided. See https://openenergyplatform.github.io/academy/courses/08_licensing/ for further information. | | |
| 1.5.1 | name | The [SPDX](https://spdx.org/licenses/) identifier. | ODbL-1.0 | Bronze |
| 1.5.2 | title | The official (human-readable) title of the license. | Open Data Commons Open Database License 1.0 | Bronze |
| 1.5.3 | path | A link or path to the license text. | https://opendatacommons.org/licenses/odbl/1-0/index.html | Bronze |
| 1.5.4 | instruction | A short description of rights and obligations. The use of [tl;drLegal](https://tldrlegal.com/) is recommended. | You are free to share and change, but you must attribute, and share derivations under the same license. See https://tldrlegal.com/license/odc-open-database-license-odbl for further information. | Bronze |
| 1.5.5 | attribution | A copyright owner of the **source**. Must be provided if attribution licenses are used. | © Intergovernmental Panel on Climate Change 2023 | Bronze |
| 1.5.6 | copyrightStatement | A link or path that proves that the source or data has the appropriate license. This can be a page number or website imprint. | https://www.ipcc.ch/copyright/ | Bronze |
| 1.4 | publicationYear | Indicates the year when the work was published. | 2023 | Bronze |
| 1.5 | path | A URL to the original source. | https://www.ipcc.ch/report/ar6/syr/downloads/report/IPCC_AR6_SYR_FullVolume.pdf | Bronze |
| 1.6 | **licenses** | An array of objects of licenses under which the described source is provided. See https://openenergyplatform.github.io/academy/courses/08_licensing/ for further information. | | |
| 1.6.1 | name | The [SPDX](https://spdx.org/licenses/) identifier. | ODbL-1.0 | Bronze |
| 1.6.2 | title | The official (human-readable) title of the license. | Open Data Commons Open Database License 1.0 | Bronze |
| 1.6.3 | path | A link or path to the license text. | https://opendatacommons.org/licenses/odbl/1-0/index.html | Bronze |
| 1.6.4 | instruction | A short description of rights and obligations. The use of [tl;drLegal](https://tldrlegal.com/) is recommended. | You are free to share and change, but you must attribute, and share derivations under the same license. See https://tldrlegal.com/license/odc-open-database-license-odbl for further information. | Bronze |
| 1.6.5 | attribution | A copyright owner of the **source**. Must be provided if attribution licenses are used. | © Intergovernmental Panel on Climate Change 2023 | Bronze |
| 1.6.6 | copyrightStatement | A link or path that proves that the source or data has the appropriate license. This can be a page number or website imprint. | https://www.ipcc.ch/copyright/ | Bronze |

### Resource - Licenses Keys
| # | Key | Description | Example | Badge |
Expand Down

0 comments on commit 2101ae5

Please sign in to comment.