gbc newsletter -- where / how these will be posted on the website

[selineriz]

@christinerogers:
Pedro's team is drafting quarterly newsletters - this will be a pdf.
Their first newsletter is likely going out this week, it's likely you'll upload the first one to the website, under News&Events, but we want to plan a smooth way for them to do it next time ---

This means on of Pedro's team will add/upload a card and PDF on github.
We're going to need an easy solution for this so please think ahead -- can a PDF be linked/loaded in one click from a nunjucks card?

• is this already supported in the markdown available?
• if not, what's needed?
• what contributor instructions do we need to provide for this to work smoothly?

thanks @3design

@3design:

• The njk files for the news and events resources is not compatible with markdown. The excerpt field only supports plain text with no special characters such as colons or asterisk.
• the instruction to create a new card are included in the README on the code page. Basically it just requires duplicating an existing njk file in the 'resources' folder, changing the name of the njk file, then filling out the information in the template. See README for more details
• I will add a section in the README for adding PDF files and images to new cards, specifically for the upcoming newsletters

@3design:
added entry on how to add a newsletter to the News & Events page

https://github.com/3design/gbc?tab=readme-ov-file#adding-newsletters-to-the-news-and-events

Old repo link (3design/gbc):3design/gbc#17

[christinerogers]

@selineriz could you please review these instructions - Are they sufficient for someone to contribute content like a newsletter? Would you be able to make such a contribution e.g. with the info as written + what you've learned about github? Thanks

[selineriz]

I think the instructions would be clear to the majority but here are some recommendations to make it more clear and easier for everyone (I think giving examples always makes it more clear):

1. Duplicate an existing .njk file in the 'resources' folder.
   -Find an existing newsletter .njk file in the 'resources' folder and duplicate it (e.g., 20240901-September-Newsletter.njk)
2. Change the name of the .njk file using the following naming convention: (yyyy)(mm)(dd)-name.njk
   -Example: 20241015-October-Newsletter.njk.
3. Put the PDF in the folder "src/assets/images/content/newsletters/"

   • Ensure the PDF file name matches the .njk file naming convention (e.g., 20241015-October-Newsletter.pdf).
     4.Edit the content of the .njk file as above with the following differences
     -Open the new .njk file and update the content. Make sure to include:
     type: resource
     resource_link: "/assets/images/content/newsletters/(filename).pdf"

   • Replace (filename) with the actual name of your PDF file (e.g., 20241015-October-Newsletter.pdf)

4. Save and commit your changes:
   -Save your .njk file and create a pull request to the main branch

After submitting your pull request, it will be reviewed by [Name]. You will be notified of any changes needed or when it has been merged.

@christinerogers let me know if you find the details unnecessary

[christinerogers]

Thanks Selin good start, these are good suggestions.
How about shortening this ?
Perhaps we could just say -- Feel free to copy an existing card to make a new event in the resources folder. Ensure you are updating the file name and that the accompanying PDF is named to match it. Then save and commit your file(s) on a new branch and create a pull request to the main branch.
If we want to spell out the date convention, that should be covered (if it isn't) earlier in the instructions on how events/resources/cards can be contributed, and this part should simply point to that note.
would this effectively boil it down, @selineriz ?

[selineriz]

Yes I think that would work @christinerogers