From 98070a077cf3a58b509503c737f94a82a77a3296 Mon Sep 17 00:00:00 2001 From: Ludee Date: Tue, 13 Jun 2023 16:08:18 +0200 Subject: [PATCH 1/4] Add general section introduction #187 --- docs/courses/07_metadata.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/courses/07_metadata.md b/docs/courses/07_metadata.md index f78921e8..02f4c931 100644 --- a/docs/courses/07_metadata.md +++ b/docs/courses/07_metadata.md @@ -21,7 +21,11 @@ tags: ## Introduction: What is Metadata? -ToDo +Metadata, in simple terms, refers to data about data. +It provides valuable information about the characteristics, properties, +and context of a particular piece of data. +Think of it as the "who, what, when, where, and how" of data. +Metadata plays a crucial role in organizing, managing, and understanding information. ## What is the Open Energy Metadata? From af0a1769eba11f5387d079dfab714386950d82b6 Mon Sep 17 00:00:00 2001 From: Ludee Date: Tue, 13 Jun 2023 16:11:16 +0200 Subject: [PATCH 2/4] Update changelog #187 --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 332fef4d..2a374376 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,7 @@ Here is a template for new release sections ### Added +- Add general section to metadata tutorial [(#198)](https://github.com/OpenEnergyPlatform/academy/pull/198) - Add the file CONTRIBUTE.md [(#194)](https://github.com/OpenEnergyPlatform/academy/pull/194) - Add new metadata course [(#195)](https://github.com/OpenEnergyPlatform/academy/pull/195) - Add new licensing course [(#190)](https://github.com/OpenEnergyPlatform/academy/pull/190) From 6ba18c2b27544130e48497dd39b88a7b68196b65 Mon Sep 17 00:00:00 2001 From: christian-rli Date: Tue, 13 Jun 2023 18:14:34 +0200 Subject: [PATCH 3/4] Consistent plural form and some rephrasing #198 --- docs/courses/07_metadata.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/courses/07_metadata.md b/docs/courses/07_metadata.md index 02f4c931..1be67cd1 100644 --- a/docs/courses/07_metadata.md +++ b/docs/courses/07_metadata.md @@ -21,10 +21,10 @@ tags: ## Introduction: What is Metadata? -Metadata, in simple terms, refers to data about data. -It provides valuable information about the characteristics, properties, -and context of a particular piece of data. -Think of it as the "who, what, when, where, and how" of data. +Metadata, in simple terms, refer to data about data. +They provide valuable information regarding the characteristics, properties, +and context of a specific data item. +Metadata answer the questions of "who, what, when, where, and how" related to the data. Metadata plays a crucial role in organizing, managing, and understanding information. ## What is the Open Energy Metadata? From b77c4d2fc9234339daee55f9fa1f6fa8d09b4870 Mon Sep 17 00:00:00 2001 From: christian-rli Date: Tue, 13 Jun 2023 18:24:48 +0200 Subject: [PATCH 4/4] Change order and a few words #198 --- docs/courses/07_metadata.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/courses/07_metadata.md b/docs/courses/07_metadata.md index 1be67cd1..e49f1153 100644 --- a/docs/courses/07_metadata.md +++ b/docs/courses/07_metadata.md @@ -29,20 +29,20 @@ Metadata plays a crucial role in organizing, managing, and understanding informa ## What is the Open Energy Metadata? -- The [Open Energy Metadata](https://github.com/OpenEnergyPlatform/oemetadata) (OEMetadata) describe a metadata standard used to annotate energy related data +- [Open Energy Metadata](https://github.com/OpenEnergyPlatform/oemetadata) (OEMetadata) describe a metadata standard used to annotate energy related data - The development of OEMetadata is a community effort and takes place on [GitHub](https://github.com/OpenEnergyPlatform/oemetadata/issues) - In the following sections of this course we have collected information on how to use the standard - There is a short :oep-icon-code: [tutorial on how to get started with OEMetadata](../tutorials/metadata/getting_started_with_OEMetadata.ipynb) ## What's the meaning of all the metadata keys? -- There is a comprehensive list of keys, their meaning and example uses in the :oep-icon-text: [key description](https://github.com/OpenEnergyPlatform/oemetadata/blob/master/metadata/latest/metadata_key_description.md) in the OEMetadata repository +- The OEMetadata repository provides a comprehensive list of keys, along with their meanings and examples of their uses, in the [key description](https://github.com/OpenEnergyPlatform/oemetadata/blob/master/metadata/latest/metadata_key_description.md) section. ## How can I work with OEMetadata? +- A :oep-icon-code: [guide on publishing data on the OEP](../tutorials/upload/OEP_Research_Data_Publishing_Guidebook.ipynb) includes the creation of metadata - For all datasets on the [Open Energy Platform (OEP)](https://openenergy-platform.org/), you can look at provided metadata by clicking on "Meta Information" - If you are the owner of the dataset, you can click "edit" and you're directly working on the OEMetadata -- [A guide on publishing data on the OEP](../tutorials/upload/OEP_Research_Data_Publishing_Guidebook.ipynb) includes the creation of metadata ## What other tools to work with OEMetadata are there?