Commits
The existing verbiage read a little more "legal" than desired. (Specifically the phrasing "provided that")
The new wording, hopefully, better communicates the excitement/appreciation many maintainers feel when someone else finds their project useful.
Hopefully the extra detail makes it much easier for other contributors to share their abilities with the project.
I bought a dedicated domain name for this project!
When I added a new announcement, I was initially confused why it didn't appear in the website. Turns out it was being excluded as a draft :/
For this project, we use PRs to showcase draft work. We don't need an extra setting in the code.
While there are only three announcements right now, in a future day there may be many more.
Alphabeticall ordering is the most sensible choice for evergreen content like this.
By following these instructions, by new badge was looking different from the others. It took a bit to figure out the difference, so I'm updating the notes here to be more precise.
Ideally, someday the badges are fully auto-generated. But that day is not yet here.
The "Visitors" and "Maintainers" headings were my first attempt to clarify the difference in intended audiences for each part of the announcement.
But those headings only make sense if the reader thinks of himself/herself as a "visitor" or a ",maintainer".
Removing the "visitor" heading immediately places more focus on the content of the announcement since there's no longer an extraneous heading.
Replacing the "Maintainers" heading with "Add this badge to your project" both makes the section more actionable, and subtley opens the invitation to individuals who don't think of themselves as "maintainers".
Moves some sentances around to shorten the amount of text introducing the bullet points -- thus making the bullet points stand out more.
My original contributing instructions were great for working on an established project, but were lacking on getting started.
This commit adds additional documentation/scripts to facilitate getting started more easily.
In production, the badge was linking to a URL that duplicated
the slug.
Now it correctly links to the same article.
Allows them to be published publically!
This is the strong recommendation from Hugo since it better
handles slashes, i18n, and more: https://gohugo.io/functions/urls/absurl/
They are no longer needed since their directories now contain
other tracked files.
I'll initially launch the project as a personal subdomain.
Describe the purpose of the site in a little more detail
and give credit to the spiritual progenitor of the project.
The RSS feed was showing publications in January 0001.
Since the dates no longer appear in the PSA template (the
content should be evergreen) I'm now comfortable restoring
them to the front matter.
Explain to others, including future me, how to add new
announcements easily.
The maintainer instructions are essentially identical between
announcements. No need to facilitate duplication of writing
where it's unnecessary.
Additionally, the shorter announcement template makes it easier
to find the TODO line describing next steps for the contributor.
Refactors the config to make it easier to translate.
Added a nice landing page describing the site.
Adjusted settings so that PSAs are listed on the home page.
The "Visitors" and "Maintainers" headings were my first attempt to clarify the difference in intended audiences for each part of the announcement.
But those headings only make sense if the reader thinks of himself/herself as a "visitor" or a ",maintainer".
Removing the "visitor" heading immediately places more focus on the content of the announcement since there's no longer an extraneous heading.
Replacing the "Maintainers" heading with "Add this badge to your project" both makes the section more actionable, and subtley opens the invitation to individuals who don't think of themselves as "maintainers".