Merge pull request #209 from OpenEnergyPlatform/bugfix-204-docs

Update README and move old versions #204

CHANGELOG.md

@@ -6,11 +6,26 @@ For each version, important additions, changes and removals are listed here.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
+## [Unreleased]
+
+### Added
+- [(#)]()
+
+### Changed
+- Update documentation and README [(#209)](https://github.com/OpenEnergyPlatform/oemetadata/pull/209)
+- Move old metadata versions to folder [(#209)](https://github.com/OpenEnergyPlatform/oemetadata/pull/209)
+
+### Removed
+- [(#)]()
+
+
 ## [2.0.1] - Major Release - Refactor OEMetadata for NFDI
 
 ### Changed
 - HotFix naming errors in some files related to the renaming of master to production [#202](https://github.com/OpenEnergyPlatform/oemetadata/issues/202)
 
+
 ## [2.0.0] - Major Release - Refactor OEMetadata for NFDI
 
 ### Added

README.rst

@@ -37,9 +37,9 @@ Introduction
 
 You can find the latest version right here:
 
-- `template.json <./metadata/latest/template.json>`_ contains an empty metadata string
-- `metadata_key_description.md <./metadata/latest/metadata_key_description.md>`_ contains a description of each metadata key
-- `example.json <./metadata/latest/example.json>`_ contains a basic metadata example
+- `template.json <https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/template.json>`_ contains an empty metadata string
+- `example.json <https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/example.json>`_ contains a basic metadata example
+- `metadata_key_description.md <https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/metadata_key_description.md>`_ contains a description of each metadata key
 
 Documentation
 =============
@@ -66,36 +66,44 @@ License and Citation
 
 
 .. |badge_license| image:: https://img.shields.io/github/license/OpenEnergyPlatform/oemetadata
-    :target: LICENSE.txt
+    :target: https://github.com/OpenEnergyPlatform/oemetadata/blob/production/LICENSE.txt
     :alt: License
 
 .. |badge_documentation| image:: https://img.shields.io/github/actions/workflow/status/OpenEnergyPlatform/oemetadata/gh-pages.yml?branch=release-v2.0.1
     :target: https://openenergyplatform.github.io/oemetadata/
     :alt: Documentation
 
 .. |badge_pypi| image:: https://img.shields.io/pypi/v/oemetadata
+    :target: https://pypi.org/project/oemetadata/
     :alt: PyPI
 
 .. |badge_pypi_downloads| image:: https://img.shields.io/pypi/dm/oemetadata
+    :target: https://openenergyplatform.github.io/oemetadata/
     :alt: PyPI Downloads
 
 .. |badge_contributing| image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
+    :target: https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/CONTRIBUTING.md
     :alt: Contributions
 
 .. |badge_repo_counts| image:: http://hits.dwyl.com/OpenEnergyPlatform/oemetadata.svg
     :alt: Counter
 
 .. |badge_contributors| image:: https://img.shields.io/github/contributors/OpenEnergyPlatform/oemetadata
+    :target: https://github.com/OpenEnergyPlatform/oemetadata/graphs/contributors
     :alt: Contributors
 
 .. |badge_issue_open| image:: https://img.shields.io/github/issues-raw/OpenEnergyPlatform/oemetadata
+    :target: https://github.com/OpenEnergyPlatform/oemetadata/issues
     :alt: Open issues
 
 .. |badge_issue_closes| image:: https://img.shields.io/github/issues-closed-raw/OpenEnergyPlatform/oemetadata
-    :alt: Closes issues
+    :target: https://github.com/OpenEnergyPlatform/oemetadata/issues?q=is%3Aissue+is%3Aclosed
+    :alt: Closed issues
 
 .. |badge_pr_open| image:: https://img.shields.io/github/issues-pr-raw/OpenEnergyPlatform/oemetadata
-    :alt: Closes issues
+    :target: https://github.com/OpenEnergyPlatform/oemetadata/pulls
+    :alt: Open PR
 
 .. |badge_pr_closes| image:: https://img.shields.io/github/issues-pr-closed-raw/OpenEnergyPlatform/oemetadata
-    :alt: Closes issues
+    :target: https://github.com/OpenEnergyPlatform/oemetadata/pulls?q=is%3Apr+is%3Aclosed
+    :alt: Closed PR

docs/metadata/index.md

@@ -5,7 +5,10 @@ It is an extensive set of metadata based on the [Data Package Standard 2.0](http
 It is made to facilitate findability, accessibility, interoperability, and reusability (FAIR) of data. <br>
 A badge system prioritises the keys and serves as a measure of the completeness and quality of the metadata entries.
 
-The metadata contains multiple fields (keys) in a nested JSON structure.
-- `metadata_key_description.md` contains a full description of each metadata key.
-- `template.json` contains an empty metadata string with all fields.
-- `example.json` contains a basic metadata example.
+The metadata contains keys in a nested JSON structure.<br>
+The metadata standard includes the following files
+
+- [`schema.json`](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/schema.json) contains the complete schema.
+- [`metadata_key_description.md`](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/metadata_key_description.md) contains a full description of each metadata key.
+- [`template.json`](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/template.json) contains an empty metadata string with all fields.
+- [`example.json`](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/example.json) contains a basic metadata example.