Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorentLvr authored Aug 16, 2023
1 parent aeda89f commit 8db15eb
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 8db15eb

Please sign in to comment.