rdwatters / hugo-docs-concept

NO LONGER MAINTAINED. See the official Hugo docs at /gohugoio/hugoDocs
17 stars 10 forks source link

Add release notes for v0.20 - 0.25.1 #161

Closed digitalcraftsman closed 7 years ago

digitalcraftsman commented 7 years ago

I tried my best insert the right meta data in the front matter.

There are some issues related to this pull requests:

rdwatters commented 7 years ago

Thanks much @digitalcraftsman!

digitalcraftsman commented 7 years ago

We should also consider to add a pagination to the growing list of release notes

rdwatters commented 7 years ago

@digitalcraftsman

However, with the lately improvements of the release process we released multiple times a month. Hence I suggest to use the version number instead, e.g. "Hugo has been released"

I agree. The release notes are automatically generated, no? If so, I'm guessing we need to create issues in the Hugo repo?

The summaries of the release notes at http://localhost:1313/categories/releases/ contains Markdown that isn't rendered as such. Either we use the markdownify template func, which could mess up the layout due to headings, or we have to think about the insertion of a custom summary divider.

Also agree, but this is perhaps an issue in the hugo theme repo? Honestly, I've never trusted auto-generated summaries and pretty much always prefer to write a <200-character .Description in each content file. Better control and better flexibility/output, IMHO.

digitalcraftsman commented 7 years ago

The release notes are partly generated. Bjørn Erik uses a script to traverse the Git log. The final output is a list of commit titles with it's hash and author that a already sorted into different categories like features, fixes etc.

Later we add a description/preamble and do some clean up regarding the commits.

I see two ways to add release notes to the docs. Option one is that we copy the release notes from GitHub, which aren't that bad, and add manually a good title for the sidebar on the left. The latter option is two summarize the release with a separate description similar to Jekyll.

budparr commented 7 years ago

So when we started the new design and I added a "news/blog" section, I intended for one category there to be a summary or some subset of official releases. Just FYI.

digitalcraftsman commented 7 years ago

I intended for one category there to be a summary or some subset of official releases. Just FYI.

Does the subset exclude smaller bugfix releases?

budparr commented 7 years ago

I've avoided the idea of setting rules for this (not that it's my place to do so in the first place), but I envision it as the "public face" of Hugo news, so likely more significant milestones rather than patches.

digitalcraftsman commented 7 years ago

I envision it as the "public face" of Hugo news, so likely more significant milestones rather than patches.

With this focus it makes totally sense

rdwatters commented 7 years ago

but I envision it as the "public face" of Hugo news

Agreed, but that's going to require authors to make contributions to fit this metric (not that I'm saying they haven't already). I don't mind having patch and minor releases. One area that @moorereason had mentioned was the importance of a deprecation/breaking changes area; as in, with every release, please see here before going to to the forums to find out why your site is breaking. Maybe this is best interspersed in docs content, maybe best at /troubleshooting, maybe as a fixed section in the releases notes/news. I'm not sure. What do you guys think?