556 auto generate post descriptions

[kjaymiller]

• add ollama_summarizer.py
• update requirements
• update layouts to include descriptions
• update posts

Issue Link 🔗:

Issue: #[Issue_Number]

UPDATE

While trying to get tests to pass, I ran into an issue where the default post was not being applied. The most verbose fix is to auto apply it when it is missing.

I wrote about this in #564
To fix this I made a somewhat large change.

• I added the update_layout.py cli tool that checks for a layout field and will apply it if missing (you can supply as many posts to check)
• created a custom pre-commit hook that runs update_layout on any .md files in _posts that are not updated. this works like all other pre-commit hooks in that the hook will fail, but it will fix the issue.
  I updated the documentation in contributors.md

Type of Change

• Bug fix 🐞
• New feature/page
• Documentation update
• Other

Description 📋

• What: Provide an overview of the issue this PR addresses. Explain the context and background information.

This PR uses the ollama_summarizer tool to check all the posts for descriptions, creating new descriptions if they currently do not exist.

It also adds the new descriptions to the meta descriptions as well as the blog lists instead of excerpts...

• Why: Describe why the changes are being made. Highlight key updates, new features, or bug fixes.

Excerpts were being cutoff in some posts and their HTML was showing. This tool instead can be used to quickly generate descritpions based on the contents and use AI to quickly update.

It's also easy to change the description if there is a report of a bad descriptions.

• How: Explain how these changes will affect the project or end-users.

This will make our social media links more dynamic and engaging and also it will give folks a summary of the content they are about to explore.

Checklist ✅

• Followed the Code of Conduct and Contribution Guide
• Ran pre-commit run --all
• All tests pass locally
• Added tests (if applicable)
• Documentation updated (if applicable)

Additional Notes & Screenshots

Add any additional notes or comments that might be helpful for the reviewers.

[TimOsahenru]

Initially found this really insightful ... wanted to try this and get my hands messy on it 😔. Did we happen to stream this?

[kjaymiller]

Initially found this really insightful ... wanted to try this and get my hands messy on it 😔. Did we happen to stream this?

sadly no but I did write this blog post about it late last night - https://kjaymiller.com/blog/i-made-a-precommit-hook-it-wasn-t-that-bad.html

I think the auto-generate posts thing was a temporary fix. I think long term the CLI in pre-commit is the better solution where we fail pre-commit run if there is no description.

[kjaymiller]

In the meantime. @TimOsahenru can you review the PR so we can get it pushed?

[TimOsahenru]

Looks good to me! I noticed that some articles still don’t have an author tag. We could consider adding a default, like 'BPD,' for articles without a specified author to keep things consistent.

[TimOsahenru]

Can we have a default author for this to make things a bit consistent.

[TimOsahenru]

and this too

[TimOsahenru]

and this too... we could have "BPD" as a default author for those articles without authors

[kjaymiller]

Looks good to me! I noticed that some articles still don’t have an author tag. We could consider adding a default, like 'BPD,' for articles without a specified author to keep things consistent.

Good news is I was the author of these posts so I can update that in a followup issue.

I think a new issue (not to delay this PR) is to have fields that have to be filled in order for pre-commit to pass...

I think we can modify the existing update_layout.py (maybe rename it to posts_validation.py) to look for parameters and optionally set a default.

Again I think that is a different issue. In fact the only reason this was added in this issue was that I wanted to ensure that our tests were passing.

[kjaymiller]

In the meantime @TimOsahenru if it's good add your review approval to get this wrapped up.