From 8db15eb97b3234125394298f0d84e993f4068fc6 Mon Sep 17 00:00:00 2001 From: FlorentLvr <48032461+FlorentLvr@users.noreply.github.com> Date: Wed, 16 Aug 2023 16:30:16 +0200 Subject: [PATCH] Update README.md --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bbc290dc89..ebe3f2bc43 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,12 @@ The repository is organized by source/tools for easy discovery. You can also use To ensure the quality of the templates, we have defined a framework. Each notebook shall be organized with the following sections: - **Naas logo** -- **# Title**: "Tool - Action of the notebook", as h1 (an "Open in Naas" button will be automatically added by the CI/CD when a notebook is merged to the master branch) -- **Tags**: hastags of the topics the notebook is about, as text -- **Author**: name and social profile link of the author(s), as text -- **Description**: a one-liner explaining the benefits of the notebooks for the user, as text +- **# Title**: "Tool - Action of the notebook", as h1. An "Open in Naas" button will be added automatically by the CI/CD when a notebook is merged to the master branch. +- **Tags:**: hashtags relevant to the topics covered in the notebook, as text +- **Author:**: name and social profile link of the author(s), as text +- **Last update:** YYYY-MM-DD (Created: YYYY-MM-DD): The last update date refers to when the notebook was last edited, while the created date corresponds to when the notebook was initially merged. +- **Description:**: a one-liner explaining the benefits of the notebooks for the user, as text +- **References:**: list of references and websites utilized in the creation of this notebook - **## Input**: list of all the variables, credentials, that needs to be setup, as h2 - **## Model**: list the functions applied to the data, as h2 - **## Output**: list the assets to be used by the user and its distribution channels if any, as h2