chore: instructions in the readme

::by sergio giraldo @ 20240716T2044CEST, gpg signed
sergiorgiraldo · Jul 16, 2024 · 23bfced · 23bfced
1 parent 2edb438
commit 23bfced
Show file tree

Hide file tree

Showing 6 changed files with 54 additions and 23 deletions.
diff --git a/ITERATION b/ITERATION
@@ -1 +1 @@
-0.0.154
+0.0.156
diff --git a/README.md b/README.md
@@ -6,15 +6,15 @@ My journey
 
 https://sergiorgiraldo.github.io/phd/
 
-### Status
+## Status
 
 [![Deployment](https://github.com/sergiorgiraldo/phd/actions/workflows/jekyll.yml/badge.svg)](https://github.com/sergiorgiraldo/phd/actions/workflows/jekyll.yml)
 
 ## Project
 
 https://github.com/users/sergiorgiraldo/projects/3 
 
-### Status
+## status
 
 ![Static Badge](https://img.shields.io/badge/Backlog-2-red?style=for-the-badge)
 
@@ -23,3 +23,13 @@ https://github.com/users/sergiorgiraldo/projects/3
 ![Static Badge](https://img.shields.io/badge/Doing-1-green?style=for-the-badge)
 
 ![Static Badge](https://img.shields.io/badge/Done-2-blue?style=for-the-badge)
+
+---
+
+## Howto
+
+- There are a few helpers, use shell scripts `newpost`, `newreview`, `newtask` for new content
+
+- Badges in readme and about pages are generated automatically running shell script `queryproject` in the pre-commit hook. 
+
+The pre-commit hook also bundles the Jekyll site into the `_site` folder. This is then picked by the github workflow and publishes in my GH pages.
diff --git a/_site/feed.xml b/_site/feed.xml
@@ -1,15 +1,22 @@
-<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="4.3.3">Jekyll</generator><link href="https://sergiorgiraldo.github.io/phd/feed.xml" rel="self" type="application/atom+xml" /><link href="https://sergiorgiraldo.github.io/phd/" rel="alternate" type="text/html" /><updated>2024-05-14T13:24:38+02:00</updated><id>https://sergiorgiraldo.github.io/phd/feed.xml</id><title type="html">PHD SRG.</title><subtitle>Sergio Giraldo, PhD student.</subtitle><author><name>Sergio Giraldo</name></author><entry><title type="html">AI Based Banking Data Analysis with a Design Thinking Approach</title><link href="https://sergiorgiraldo.github.io/phd/2024/05/09/AI-Based-Banking-Data-Analysis-with-a-Design-Think.html" rel="alternate" type="text/html" title="AI Based Banking Data Analysis with a Design Thinking Approach" /><published>2024-05-09T14:54:36+02:00</published><updated>2024-05-09T14:54:36+02:00</updated><id>https://sergiorgiraldo.github.io/phd/2024/05/09/AI-Based-Banking-Data-Analysis-with-a-Design-Think</id><content type="html" xml:base="https://sergiorgiraldo.github.io/phd/2024/05/09/AI-Based-Banking-Data-Analysis-with-a-Design-Think.html"><![CDATA[]]></content><author><name>Sergio Giraldo</name></author><category term="design-thinking" /><summary type="html"><![CDATA[]]></summary></entry><entry><title type="html">Leiden</title><link href="https://sergiorgiraldo.github.io/phd/2024/05/05/uni-leiden.html" rel="alternate" type="text/html" title="Leiden" /><published>2024-05-05T22:37:00+02:00</published><updated>2024-05-05T22:37:00+02:00</updated><id>https://sergiorgiraldo.github.io/phd/2024/05/05/uni-leiden</id><content type="html" xml:base="https://sergiorgiraldo.github.io/phd/2024/05/05/uni-leiden.html"><![CDATA[[Faculty of Science](https://www.universiteitleiden.nl/en/science/graduate-school-of-science)]]></content><author><name>Sergio Giraldo</name></author><category term="unis" /><summary type="html"><![CDATA[Faculty of Science]]></summary></entry><entry><title type="html">Erasmus Rotterdam</title><link href="https://sergiorgiraldo.github.io/phd/2024/05/05/uni-erasmus.html" rel="alternate" type="text/html" title="Erasmus Rotterdam" /><published>2024-05-05T22:34:00+02:00</published><updated>2024-05-05T22:34:00+02:00</updated><id>https://sergiorgiraldo.github.io/phd/2024/05/05/uni-erasmus</id><content type="html" xml:base="https://sergiorgiraldo.github.io/phd/2024/05/05/uni-erasmus.html"><![CDATA[I couldnt find a suitable program in the topics I chose. I'll try again by EOY, maybe new fields arise.]]></content><author><name>Sergio Giraldo</name></author><category term="unis" /><summary type="html"><![CDATA[I couldnt find a suitable program in the topics I chose. I’ll try again by EOY, maybe new fields arise.]]></summary></entry><entry><title type="html">University of Amsterdam - UvA</title><link href="https://sergiorgiraldo.github.io/phd/2024/05/05/uni-amsterdam.html" rel="alternate" type="text/html" title="University of Amsterdam - UvA" /><published>2024-05-05T22:28:00+02:00</published><updated>2024-05-05T22:28:00+02:00</updated><id>https://sergiorgiraldo.github.io/phd/2024/05/05/uni-amsterdam</id><content type="html" xml:base="https://sergiorgiraldo.github.io/phd/2024/05/05/uni-amsterdam.html"><![CDATA[I couldnt find a suitable program in the topics I chose. I'll try again by EOY, maybe new fields arise.]]></content><author><name>Sergio Giraldo</name></author><category term="unis" /><summary type="html"><![CDATA[I couldnt find a suitable program in the topics I chose. I’ll try again by EOY, maybe new fields arise.]]></summary></entry><entry><title type="html">Design Thinking Topics</title><link href="https://sergiorgiraldo.github.io/phd/2024/05/03/homedt.html" rel="alternate" type="text/html" title="Design Thinking Topics" /><published>2024-05-03T17:02:00+02:00</published><updated>2024-05-03T17:02:00+02:00</updated><id>https://sergiorgiraldo.github.io/phd/2024/05/03/homedt</id><content type="html" xml:base="https://sergiorgiraldo.github.io/phd/2024/05/03/homedt.html"><![CDATA[#### 2024-05-08
+<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="4.3.3">Jekyll</generator><link href="https://sergiorgiraldo.github.io/phd/feed.xml" rel="self" type="application/atom+xml" /><link href="https://sergiorgiraldo.github.io/phd/" rel="alternate" type="text/html" /><updated>2024-07-16T20:44:30+02:00</updated><id>https://sergiorgiraldo.github.io/phd/feed.xml</id><title type="html">PHD SRG.</title><subtitle>Sergio Giraldo, PhD student.</subtitle><author><name>Sergio Giraldo</name></author><entry><title type="html">AI Based Banking Data Analysis with a Design Thinking Approach</title><link href="https://sergiorgiraldo.github.io/phd/2024/05/09/AI-Based-Banking-Data-Analysis-with-a-Design-Think.html" rel="alternate" type="text/html" title="AI Based Banking Data Analysis with a Design Thinking Approach" /><published>2024-05-09T14:54:36+02:00</published><updated>2024-05-09T14:54:36+02:00</updated><id>https://sergiorgiraldo.github.io/phd/2024/05/09/AI-Based-Banking-Data-Analysis-with-a-Design-Think</id><content type="html" xml:base="https://sergiorgiraldo.github.io/phd/2024/05/09/AI-Based-Banking-Data-Analysis-with-a-Design-Think.html"><![CDATA[]]></content><author><name>Sergio Giraldo</name></author><category term="design-thinking" /><summary type="html"><![CDATA[]]></summary></entry><entry><title type="html">Leiden</title><link href="https://sergiorgiraldo.github.io/phd/2024/05/05/uni-leiden.html" rel="alternate" type="text/html" title="Leiden" /><published>2024-05-05T22:37:00+02:00</published><updated>2024-05-05T22:37:00+02:00</updated><id>https://sergiorgiraldo.github.io/phd/2024/05/05/uni-leiden</id><content type="html" xml:base="https://sergiorgiraldo.github.io/phd/2024/05/05/uni-leiden.html"><![CDATA[<p><a href="https://www.universiteitleiden.nl/en/science/graduate-school-of-science">Faculty of Science</a></p>]]></content><author><name>Sergio Giraldo</name></author><category term="unis" /><summary type="html"><![CDATA[Faculty of Science]]></summary></entry><entry><title type="html">Erasmus Rotterdam</title><link href="https://sergiorgiraldo.github.io/phd/2024/05/05/uni-erasmus.html" rel="alternate" type="text/html" title="Erasmus Rotterdam" /><published>2024-05-05T22:34:00+02:00</published><updated>2024-05-05T22:34:00+02:00</updated><id>https://sergiorgiraldo.github.io/phd/2024/05/05/uni-erasmus</id><content type="html" xml:base="https://sergiorgiraldo.github.io/phd/2024/05/05/uni-erasmus.html"><![CDATA[<p>I couldnt find a suitable program in the topics I chose. I’ll try again by EOY, maybe new fields arise.</p>]]></content><author><name>Sergio Giraldo</name></author><category term="unis" /><summary type="html"><![CDATA[I couldnt find a suitable program in the topics I chose. I’ll try again by EOY, maybe new fields arise.]]></summary></entry><entry><title type="html">University of Amsterdam - UvA</title><link href="https://sergiorgiraldo.github.io/phd/2024/05/05/uni-amsterdam.html" rel="alternate" type="text/html" title="University of Amsterdam - UvA" /><published>2024-05-05T22:28:00+02:00</published><updated>2024-05-05T22:28:00+02:00</updated><id>https://sergiorgiraldo.github.io/phd/2024/05/05/uni-amsterdam</id><content type="html" xml:base="https://sergiorgiraldo.github.io/phd/2024/05/05/uni-amsterdam.html"><![CDATA[<p>I couldnt find a suitable program in the topics I chose. I’ll try again by EOY, maybe new fields arise.</p>]]></content><author><name>Sergio Giraldo</name></author><category term="unis" /><summary type="html"><![CDATA[I couldnt find a suitable program in the topics I chose. I’ll try again by EOY, maybe new fields arise.]]></summary></entry><entry><title type="html">Design Thinking Topics</title><link href="https://sergiorgiraldo.github.io/phd/2024/05/03/homedt.html" rel="alternate" type="text/html" title="Design Thinking Topics" /><published>2024-05-03T17:02:00+02:00</published><updated>2024-05-03T17:02:00+02:00</updated><id>https://sergiorgiraldo.github.io/phd/2024/05/03/homedt</id><content type="html" xml:base="https://sergiorgiraldo.github.io/phd/2024/05/03/homedt.html"><![CDATA[<h4 id="2024-05-08">2024-05-08</h4>
 
-- [Designing an Energy Tracker and Smart Home Solutions Using Design Thinking Methodology](https://ieeexplore.ieee.org/document/10291478) - 2023
+<ul>
+  <li>
+    <p><a href="https://ieeexplore.ieee.org/document/10291478">Designing an Energy Tracker and Smart Home Solutions Using Design Thinking Methodology</a> - 2023</p>
+  </li>
+  <li>
+    <p><a href="https://ieeexplore.ieee.org/document/10477817">Design Thinking Evidence in Software Development: Results from a Systematic Mapping</a> - 2024</p>
+  </li>
+  <li>
+    <p><a href="https://ieeexplore.ieee.org/document/10128407">Relating the DT Framework in Securing the Healthcare Data using Blockchain</a> -2023</p>
+  </li>
+  <li>
+    <p><a href="https://ieeexplore.ieee.org/document/10511224">AI Based Banking Data Analysis with a Design Thinking Approach</a> - 2024</p>
+  </li>
+</ul>]]></content><author><name>Sergio Giraldo</name></author><category term="design-thinking" /><summary type="html"><![CDATA[2024-05-08]]></summary></entry><entry><title type="html">Software Architecture - API’s Topics</title><link href="https://sergiorgiraldo.github.io/phd/2024/05/03/homeapis.html" rel="alternate" type="text/html" title="Software Architecture - API’s Topics" /><published>2024-05-03T17:02:00+02:00</published><updated>2024-05-03T17:02:00+02:00</updated><id>https://sergiorgiraldo.github.io/phd/2024/05/03/homeapis</id><content type="html" xml:base="https://sergiorgiraldo.github.io/phd/2024/05/03/homeapis.html"><![CDATA[<h1 id="home---software-architecture---apis-topics">Home - Software Architecture - API’s Topics</h1>]]></content><author><name>Sergio Giraldo</name></author><category term="software-architecture" /><category term="apis" /><summary type="html"><![CDATA[Home - Software Architecture - API’s Topics]]></summary></entry><entry><title type="html">Software Architecture - Data Distribution Topics</title><link href="https://sergiorgiraldo.github.io/phd/2024/05/03/homedata.html" rel="alternate" type="text/html" title="Software Architecture - Data Distribution Topics" /><published>2024-05-03T17:02:00+02:00</published><updated>2024-05-03T17:02:00+02:00</updated><id>https://sergiorgiraldo.github.io/phd/2024/05/03/homedata</id><content type="html" xml:base="https://sergiorgiraldo.github.io/phd/2024/05/03/homedata.html"><![CDATA[<h1 id="home---software-architecture---data-distribution-topics">Home - Software Architecture - Data Distribution Topics</h1>]]></content><author><name>Sergio Giraldo</name></author><category term="software-architecture" /><category term="data-distribution" /><summary type="html"><![CDATA[Home - Software Architecture - Data Distribution Topics]]></summary></entry><entry><title type="html">Software Architecture - Agents Topics</title><link href="https://sergiorgiraldo.github.io/phd/2024/05/03/homeagents.html" rel="alternate" type="text/html" title="Software Architecture - Agents Topics" /><published>2024-05-03T17:02:00+02:00</published><updated>2024-05-03T17:02:00+02:00</updated><id>https://sergiorgiraldo.github.io/phd/2024/05/03/homeagents</id><content type="html" xml:base="https://sergiorgiraldo.github.io/phd/2024/05/03/homeagents.html"><![CDATA[<h1 id="home---software-architecture---agents-topics">Home - Software Architecture - Agents Topics</h1>]]></content><author><name>Sergio Giraldo</name></author><category term="software-architecture" /><category term="agents" /><summary type="html"><![CDATA[Home - Software Architecture - Agents Topics]]></summary></entry><entry><title type="html">Welcome!</title><link href="https://sergiorgiraldo.github.io/phd/2024/05/02/setup.html" rel="alternate" type="text/html" title="Welcome!" /><published>2024-05-02T16:24:27+02:00</published><updated>2024-05-02T16:24:27+02:00</updated><id>https://sergiorgiraldo.github.io/phd/2024/05/02/setup</id><content type="html" xml:base="https://sergiorgiraldo.github.io/phd/2024/05/02/setup.html"><![CDATA[<p>Welcome, this is my first post. Starting today my journey, I’ve decided to pursue my PHD, I know it’s not that easy but …</p>
 
-- [Design Thinking Evidence in Software Development: Results from a Systematic Mapping](https://ieeexplore.ieee.org/document/10477817) - 2024
+<p>I set up the project in GH plus the website.</p>]]></content><author><name>Sergio Giraldo</name></author><category term="meta" /><summary type="html"><![CDATA[Welcome, this is my first post. Starting today my journey, I’ve decided to pursue my PHD, I know it’s not that easy but …]]></summary></entry><entry><title type="html">Universiteit Utrecht</title><link href="https://sergiorgiraldo.github.io/phd/2024/05/02/uni-utrecht.html" rel="alternate" type="text/html" title="Universiteit Utrecht" /><published>2024-05-02T16:24:27+02:00</published><updated>2024-05-02T16:24:27+02:00</updated><id>https://sergiorgiraldo.github.io/phd/2024/05/02/uni-utrecht</id><content type="html" xml:base="https://sergiorgiraldo.github.io/phd/2024/05/02/uni-utrecht.html"><![CDATA[<p><a href="https://www.uu.nl/en/research/software/software-production">Software Production</a></p>
 
-- [Relating the DT Framework in Securing the Healthcare Data using Blockchain](https://ieeexplore.ieee.org/document/10128407) -2023
+<p><a href="https://www.uu.nl/en/research/software/software-technology">Software Technology</a></p>
 
-- [AI Based Banking Data Analysis with a Design Thinking Approach](https://ieeexplore.ieee.org/document/10511224) - 2024]]></content><author><name>Sergio Giraldo</name></author><category term="design-thinking" /><summary type="html"><![CDATA[2024-05-08]]></summary></entry><entry><title type="html">Software Architecture - API’s Topics</title><link href="https://sergiorgiraldo.github.io/phd/2024/05/03/homeapis.html" rel="alternate" type="text/html" title="Software Architecture - API’s Topics" /><published>2024-05-03T17:02:00+02:00</published><updated>2024-05-03T17:02:00+02:00</updated><id>https://sergiorgiraldo.github.io/phd/2024/05/03/homeapis</id><content type="html" xml:base="https://sergiorgiraldo.github.io/phd/2024/05/03/homeapis.html"><![CDATA[# Home - Software Architecture - API's Topics]]></content><author><name>Sergio Giraldo</name></author><category term="software-architecture" /><category term="apis" /><summary type="html"><![CDATA[Home - Software Architecture - API’s Topics]]></summary></entry><entry><title type="html">Software Architecture - Data Distribution Topics</title><link href="https://sergiorgiraldo.github.io/phd/2024/05/03/homedata.html" rel="alternate" type="text/html" title="Software Architecture - Data Distribution Topics" /><published>2024-05-03T17:02:00+02:00</published><updated>2024-05-03T17:02:00+02:00</updated><id>https://sergiorgiraldo.github.io/phd/2024/05/03/homedata</id><content type="html" xml:base="https://sergiorgiraldo.github.io/phd/2024/05/03/homedata.html"><![CDATA[# Home - Software Architecture - Data Distribution Topics]]></content><author><name>Sergio Giraldo</name></author><category term="software-architecture" /><category term="data-distribution" /><summary type="html"><![CDATA[Home - Software Architecture - Data Distribution Topics]]></summary></entry><entry><title type="html">Software Architecture - Agents Topics</title><link href="https://sergiorgiraldo.github.io/phd/2024/05/03/homeagents.html" rel="alternate" type="text/html" title="Software Architecture - Agents Topics" /><published>2024-05-03T17:02:00+02:00</published><updated>2024-05-03T17:02:00+02:00</updated><id>https://sergiorgiraldo.github.io/phd/2024/05/03/homeagents</id><content type="html" xml:base="https://sergiorgiraldo.github.io/phd/2024/05/03/homeagents.html"><![CDATA[# Home - Software Architecture - Agents Topics]]></content><author><name>Sergio Giraldo</name></author><category term="software-architecture" /><category term="agents" /><summary type="html"><![CDATA[Home - Software Architecture - Agents Topics]]></summary></entry><entry><title type="html">Welcome!</title><link href="https://sergiorgiraldo.github.io/phd/2024/05/02/setup.html" rel="alternate" type="text/html" title="Welcome!" /><published>2024-05-02T16:24:27+02:00</published><updated>2024-05-02T16:24:27+02:00</updated><id>https://sergiorgiraldo.github.io/phd/2024/05/02/setup</id><content type="html" xml:base="https://sergiorgiraldo.github.io/phd/2024/05/02/setup.html"><![CDATA[Welcome, this is my first post. Starting today my journey, I've decided to pursue my PHD, I know it's not that easy but ...
-
-I set up the project in GH plus the website.]]></content><author><name>Sergio Giraldo</name></author><category term="meta" /><summary type="html"><![CDATA[Welcome, this is my first post. Starting today my journey, I’ve decided to pursue my PHD, I know it’s not that easy but …]]></summary></entry><entry><title type="html">Universiteit Utrecht</title><link href="https://sergiorgiraldo.github.io/phd/2024/05/02/uni-utrecht.html" rel="alternate" type="text/html" title="Universiteit Utrecht" /><published>2024-05-02T16:24:27+02:00</published><updated>2024-05-02T16:24:27+02:00</updated><id>https://sergiorgiraldo.github.io/phd/2024/05/02/uni-utrecht</id><content type="html" xml:base="https://sergiorgiraldo.github.io/phd/2024/05/02/uni-utrecht.html"><![CDATA[[Software Production](https://www.uu.nl/en/research/software/software-production)
-
-[Software Technology](https://www.uu.nl/en/research/software/software-technology)
-
-[Process Science](https://www.uu.nl/en/research/software/process-science)]]></content><author><name>Sergio Giraldo</name></author><category term="unis" /><summary type="html"><![CDATA[Software Production]]></summary></entry></feed>
+<p><a href="https://www.uu.nl/en/research/software/process-science">Process Science</a></p>]]></content><author><name>Sergio Giraldo</name></author><category term="unis" /><summary type="html"><![CDATA[Software Production]]></summary></entry></feed>
diff --git a/newpost b/newpost
@@ -2,7 +2,7 @@
 
 import sys
 from datetime import datetime, timedelta, timezone
-
+import re
 
 def main(args):
     if len(args) < 3:
@@ -11,7 +11,7 @@ def main(args):
         print("categories should be quoted and separated by commas")
         sys.exit(2)
 
-    name = args[0]
+    name = get_name(args[0])
     title = args[1]
     cats = args[2]
 
@@ -28,11 +28,15 @@ def main(args):
     with open("docs/_posts/" + short_dt + "-" + name + ".md", "w") as f:
         f.write("---\n")
         f.write("layout: post\n")
-        f.write("title: "" + title + ""\n")
+        f.write("title: " + title + "\n")
         f.write("date: " + full_dt + "\n")
         f.write("categories: [" + cats + "]\n")
         f.write("---\n\n")
 
+def get_name(name):
+    cleaned_name = re.sub(r"\s+", "-", name)
+
+    return cleaned_name[:50] if len(cleaned_name) > 50 else cleaned_name
 
 if __name__ == "__main__":
     main(sys.argv[1:])