{"id":618,"date":"2020-09-07T09:19:53","date_gmt":"2020-09-07T09:19:53","guid":{"rendered":"https:\/\/smartdatamodels.org\/?p=618"},"modified":"2020-09-07T09:22:29","modified_gmt":"2020-09-07T09:22:29","slug":"automated-readme-md-for-data-models","status":"publish","type":"post","link":"https:\/\/smartdatamodels.org\/index.php\/automated-readme-md-for-data-models\/","title":{"rendered":"Automated README.md for data models"},"content":{"rendered":"

Currently, the README.md at data models level (inside every directory in a Subject) explaining the contents of the data models is automated, and therefore there is no need to be contributed by the contributors. See an example here for the weather forecast<\/a>.<\/p>\n

Thus, the README.md is based on the examples provided, the specification and the model.yaml.<\/p>\n

Soon the README.md for the Subject will be also automated.<\/p>\n","protected":false},"excerpt":{"rendered":"

Currently, the README.md at data models level (inside every directory in a Subject) explaining the contents of the data models is automated, and therefore there is no need to be contributed by the contributors. See an example here for the weather forecast. Thus, the README.md is based on the examples… More…<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2}},"categories":[107,109,113,115,119,117,88,143,111,125],"tags":[],"class_list":["post-618","post","type-post","status-publish","format-standard","hentry","category-smart-cities","category-smart-energy-domain","category-smart-environment","category-smart-manufacturing","category-smart-robotics","category-smart-water","category-smart-sensoring","category-smartaeronautics","category-smart-agrifood","category-smartdestinations"],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack-related-posts":[{"id":625,"url":"https:\/\/smartdatamodels.org\/index.php\/automated-readme-for-subjects\/","url_meta":{"origin":618,"position":0},"title":"Automated README for Subjects","author":"maestro","date":"08\/09\/2020","format":false,"excerpt":"As promised the README.md at Subject level explaining the different data models is automated, and therefore there is no need to be contributed by the contributors. See an example here for the weather subject Thus, the README.md is based on the data models and their descriptions, linking to the current\u2026","rel":"","context":"In "Cross Sector"","block_context":{"text":"Cross Sector","link":"https:\/\/smartdatamodels.org\/index.php\/category\/cross-sector\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":1107,"url":"https:\/\/smartdatamodels.org\/index.php\/specifications-in-languages-in-the-readme-of-the-data-models\/","url_meta":{"origin":618,"position":1},"title":"Specifications in languages in the readme of the data models","author":"maestro","date":"22\/12\/2020","format":false,"excerpt":"Now you can see the links to the specification in two languages, Spanish y French in the README.md of every data models. German and Japanese are in the queue. See here an example \u00a0","rel":"","context":"In "Smart Cities domain"","block_context":{"text":"Smart Cities domain","link":"https:\/\/smartdatamodels.org\/index.php\/category\/smart-cities\/"},"img":{"alt_text":"","src":"https:\/\/i0.wp.com\/smartdatamodels.org\/wp-content\/uploads\/2020\/12\/Selection_271.png?resize=350%2C200&ssl=1","width":350,"height":200,"srcset":"https:\/\/i0.wp.com\/smartdatamodels.org\/wp-content\/uploads\/2020\/12\/Selection_271.png?resize=350%2C200&ssl=1 1x, https:\/\/i0.wp.com\/smartdatamodels.org\/wp-content\/uploads\/2020\/12\/Selection_271.png?resize=525%2C300&ssl=1 1.5x"},"classes":[]},{"id":10048,"url":"https:\/\/smartdatamodels.org\/index.php\/korean-translation-available-for-all-data-models\/","url_meta":{"origin":618,"position":2},"title":"Korean translation available for all data models","author":"maestro","date":"02\/11\/2023","format":false,"excerpt":"The Korean translation of the specifications has been incorporated. Therefore every specification folder now it has a new file spec_KO.md with the Korean translation. See an example: Also the specification is linked from the README.md file at the front of every data model.","rel":"","context":"In "Smart Cities domain"","block_context":{"text":"Smart Cities domain","link":"https:\/\/smartdatamodels.org\/index.php\/category\/smart-cities\/"},"img":{"alt_text":"","src":"https:\/\/i0.wp.com\/smartdatamodels.org\/wp-content\/uploads\/2023\/10\/Flag_of_South_Korea.png?resize=350%2C200&ssl=1","width":350,"height":200},"classes":[]},{"id":10005,"url":"https:\/\/smartdatamodels.org\/index.php\/new-sections-in-readme\/","url_meta":{"origin":618,"position":3},"title":"New Sections in README","author":"maestro","date":"20\/10\/2023","format":false,"excerpt":"We have introduced several new sections in the README.md for all the smart data models that we've published These are: Links to CSV extensions of example payloads Links to SQL schema Services we designed to help self-contribution Such as in the data model WeatherForecast: Hope you find it useful and\u2026","rel":"","context":"In "Cross Sector"","block_context":{"text":"Cross Sector","link":"https:\/\/smartdatamodels.org\/index.php\/category\/cross-sector\/"},"img":{"alt_text":"","src":"https:\/\/i0.wp.com\/smartdatamodels.org\/wp-content\/uploads\/2023\/10\/Screenshot-2023-10-18-at-18.32.18-1024x812.png?resize=350%2C200&ssl=1","width":350,"height":200,"srcset":"https:\/\/i0.wp.com\/smartdatamodels.org\/wp-content\/uploads\/2023\/10\/Screenshot-2023-10-18-at-18.32.18-1024x812.png?resize=350%2C200&ssl=1 1x, https:\/\/i0.wp.com\/smartdatamodels.org\/wp-content\/uploads\/2023\/10\/Screenshot-2023-10-18-at-18.32.18-1024x812.png?resize=525%2C300&ssl=1 1.5x, https:\/\/i0.wp.com\/smartdatamodels.org\/wp-content\/uploads\/2023\/10\/Screenshot-2023-10-18-at-18.32.18-1024x812.png?resize=700%2C400&ssl=1 2x"},"classes":[]},{"id":2455,"url":"https:\/\/smartdatamodels.org\/index.php\/data-model-readme-improvement\/","url_meta":{"origin":618,"position":4},"title":"Data model README improvement","author":"maestro","date":"24\/05\/2021","format":false,"excerpt":"The README.md of every data model provides the links to the different translations of the specification. These sentences are now in their original languages. Additionally, these links now take to the specification in GitHub and stop prompting to be downloaded. Other information available in the README include: Links to the\u2026","rel":"","context":"In "Cross Sector"","block_context":{"text":"Cross Sector","link":"https:\/\/smartdatamodels.org\/index.php\/category\/cross-sector\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":12623,"url":"https:\/\/smartdatamodels.org\/index.php\/new-testing-process-in-progress-were-you-can-contribute-your-code\/","url_meta":{"origin":618,"position":5},"title":"New testing process in progress were you can contribute your code","author":"maestro","date":"06\/02\/2025","format":false,"excerpt":"Current test process for new and extended data models In order to approve a new data model a test needs to be passed. It cold be accessed in the 3rd option in the tools menu at the front page: Pro: it is currently working Con: It is mostly created in\u2026","rel":"","context":"In "Cross Sector"","block_context":{"text":"Cross Sector","link":"https:\/\/smartdatamodels.org\/index.php\/category\/cross-sector\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]}],"_links":{"self":[{"href":"https:\/\/smartdatamodels.org\/index.php\/wp-json\/wp\/v2\/posts\/618","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/smartdatamodels.org\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/smartdatamodels.org\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/smartdatamodels.org\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/smartdatamodels.org\/index.php\/wp-json\/wp\/v2\/comments?post=618"}],"version-history":[{"count":1,"href":"https:\/\/smartdatamodels.org\/index.php\/wp-json\/wp\/v2\/posts\/618\/revisions"}],"predecessor-version":[{"id":619,"href":"https:\/\/smartdatamodels.org\/index.php\/wp-json\/wp\/v2\/posts\/618\/revisions\/619"}],"wp:attachment":[{"href":"https:\/\/smartdatamodels.org\/index.php\/wp-json\/wp\/v2\/media?parent=618"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/smartdatamodels.org\/index.php\/wp-json\/wp\/v2\/categories?post=618"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/smartdatamodels.org\/index.php\/wp-json\/wp\/v2\/tags?post=618"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}