README.md

The yaml file

The cards data are stored in the _data/guides.yml file.

Each tutorial entry can have the following fields:

Field	Mandatory	Description	Type / Format
id	No	A unique identifier for the tutorial.	String
title	Yes	The title of the tutorial.	String
description	No	A brief description of the tutorial. Note: Markdown is supported when rendering this field in the web interface.	String
url	Yes	The URL of the tutorial.	String (URL)
technique	No	The technique(s) covered in the tutorial.	String or Array of Strings
tool	No	The tool(s) used in the tutorial.	String or Array of Strings
dataFormat	No	The data format(s) used in the tutorial.	String or Array of Strings
type	No	The type(s) of the tutorial.	String or Array of Strings
series	No	The series associated with the tutorial. If none is set, then the series field will be blank.	String or Array of Strings
date	No	The publication date of the tutorial. Must be in YYYY-MM-DD format	String (YYYY-MM-DD)

String or Array of Strings

For fields that can accept multiple values (i.e., "String or Array of Strings"), you can provide either a single string or an array of strings. For example:

technique: "Data Analysis"

or

technique: 
 - "Data Analysis"

If you want to specify multiple values, use an array format like this:

technique:
  - "Data Analysis"
  - "Visualization"

Best Practices

Follow these best practices when making updates to the _data/guides.yml file:

1. Create a new branch for your changes:

git checkout -b update-guides

2. Make your changes to the _data/guides.yml file using the text editor of your choice.
3. Validate the YAML syntax to ensure there are no errors.
4. Commit your changes with a descriptive message, following conventional commit guidelines:

git add _data/guides.yml
git commit -m "feat: updated guides.yml with new tutorial on XYZ"

5. Push your branch to the remote repository:

git push origin update-guides

6. Create a pull request on Github for review and merging.