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

Add a newsletter Archetype #104

Merged
merged 4 commits into from
Dec 5, 2024
Merged

Add a newsletter Archetype #104

merged 4 commits into from
Dec 5, 2024

Conversation

gmantele
Copy link
Member

This PullRequest aims to help the newsletter editors. It adds an Archetype for a newsletter ; in other words, it adds a template file for a newsletter.

To create a new newsletter using this template, just run: ./hugo-bin/hugo new content newsletter/XXX.md.
Then, just edit the resulting file content/newsletter/XXX.md and especially all content placeholders spread all over this file.

I have added some instructions in CONTRIBUTING.md. I hope it will be useful. And of course, if information are missing there, or if you think it should written somewhere else, I can easily change that.

What do you think about this solution? @JeremyMcCormick ? Deborah ?

@gmantele gmantele added the new feature New feature or request label Nov 28, 2024
@JeremyMcCormick
Copy link
Collaborator

Thank you. This seems helpful!

I will try it out and let you know what I think...

@JeremyMcCormick
Copy link
Collaborator

JeremyMcCormick commented Nov 28, 2024

FYI, there is an open issue on this:

#90

We would usually have this branch be called iss90 but I'm okay with leaving it as is.

@JeremyMcCormick
Copy link
Collaborator

JeremyMcCormick commented Nov 28, 2024

Instead of having instructions in CONTRIBUTING.md (which is full of other technical content), maybe we should have a dedicated NEWSLETTER.md for that information?

@gmantele gmantele linked an issue Nov 29, 2024 that may be closed by this pull request
@gmantele
Copy link
Member Author

FYI, there is an open issue on this:

#90

We would usually have this branch be called iss90 but I'm okay with leaving it as is.

Sorry, I did not know about this issue (and I did not search for one....my bad). I linked this PR with this Issue.

@gmantele
Copy link
Member Author

Instead of having instructions in CONTRIBUTING.md (which is full of other technical content), maybe we should have a dedicated NEWSLETTER.md for that information?

Ok. I do that.

@molinaro-m
Copy link
Member

Thanks for this setup.
It's important to contact the newsletter's editors to let them know about this and encourage them to use this template right away. I think the oncoming newsletter will be issue and reported on the current/old website, but having it already aligned with the new/rebuilt one would be great.

@gmantele
Copy link
Member Author

@molinaro-m , I let @JeremyMcCormick lead the coordination/communication with the newsletter's editors, unless any of you want me to speak for this specific point (in this case, please send me by email their email address).

@JeremyMcCormick , I have moved the instructions about the edition of newsletters in a separate MD file, as you've suggested. I have also added more information on how to edit the template. It is surely more technical, but I am sure it will be useful in the future ; few times already the newsletter layout/structure/content has evolved, so it may happen again.

@JeremyMcCormick JeremyMcCormick self-requested a review November 30, 2024 20:59
Copy link
Collaborator

@JeremyMcCormick JeremyMcCormick left a comment

Choose a reason for hiding this comment

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

I tested locally and this looks great - I approve.

@gmantele Feel free to make minor adjustments/improvements before merging.

My only significant request is that we have a Make target like make newsletter [name] which could be used to generate the page and automatically install/use the installed hugo binary.

If there is feedback on the template itself from Newsletter authors, we can incorporate this into future PRs. This looks fine as a starting point to me.

@gmantele
Copy link
Member Author

gmantele commented Dec 3, 2024

My only significant request is that we have a Make target like make newsletter [name] which could be used to generate the page and automatically install/use the installed hugo binary.

Very good suggestion 👍

It is now done. Note that no parameter is required with this make command. The file name of the next newsletter can be easily automatically created: just increment the ID of the last newsletter. That's what this make newsletter does while printing instructions on how to continue (these instructions may be improved by the way).

@gmantele gmantele merged commit fba14aa into main Dec 5, 2024
1 check passed
@gmantele gmantele deleted the add-newsletter-archetype branch December 5, 2024 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new feature New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add newsletter template using Hugo archetype
3 participants