Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update blog template #11881

Merged
merged 3 commits into from
May 21, 2024
Merged

Update blog template #11881

merged 3 commits into from
May 21, 2024

Conversation

sean1588
Copy link
Member

@sean1588 sean1588 commented May 21, 2024

Updates the blog template to include properties to house the social copies to be posted on twitter and linkedin. I also updated the disabledKinds config to update it to taxonomyTerm from taxonomy. This term was updated to this after hugo 0.73 from my understanding and also matches the config we were running in pulumi-hugo. I also added the category kind as well, since pulumi-hugo had this listed. It was giving me an error before I updated this when running the hugo new command to generate the blog files.

We could add linting here to enforce this, but it would fail unless we add these props to all the blog files. It also will presumably just pass for new blog posts going forward as these would already be filled out when generated from the template. Maybe we can do something like only running linting against newly added files in the commit, but I think this should be good enough for now.

@pulumi-bot
Copy link
Collaborator

Comment on lines 41 to 42
social_twitter: "social copy to post on Twitter"
social_linkedin: "social copy to post on Linkedin"
Copy link
Member

@cnunciato cnunciato May 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could also do this:

Suggested change
social_twitter: "social copy to post on Twitter"
social_linkedin: "social copy to post on Linkedin"
social:
twitter:
linkedin:

... And then leave these blank, as we do with the meta_desc. (I just wonder whether people will look right past it otherwise.)

@cnunciato
Copy link
Member

We could add linting here to enforce this, but it would fail unless we add these props to all the blog files.

This is true, but we could also fix this by backfilling with placeholder data, and lint going forward. I just worry that by not linting, we'll essentially in the same position we're in today, having to nag people to do it after the fact.

Comment on lines +38 to +40
# The social copy used to promote this post on Twitter and Linkedin. These
# properties do not actually create the post and have no effect on the
# generated blog page. They are here strictly for reference.
Copy link
Member

@cnunciato cnunciato May 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

People almost always ask for "good" examples of both of these (as each service has its own sort of "idiom") to give them have something to model their own copy by. It might be good to provide a couple of links here in the comments to help with that. Here are a few shared with me recently (when I asked for my last post):

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@sean1588
Copy link
Member Author

thanks @cnunciato! I made updates to the structure and comments. I'll follow on with adding linting around this and also backfill the existing posts.

@sean1588 sean1588 merged commit 92530cf into master May 21, 2024
5 checks passed
@sean1588 sean1588 deleted the sean/add-social-blog-template branch May 21, 2024 22:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants