search

rdwatters / hugo-docs-concept

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

Add a page about Upgrading Hugo #129

Closed moorereason closed 5 years ago

moorereason commented 7 years ago

It would help our users to know exactly how we handle breaking changes and where people should look to make sure they don't miss something. My thoughts:

  1. We only introduce breaking changes in minor releases.
  2. When necessary (and possible), we deprecate features for two minor releases. Deprecation means that warnings are logged when those features are used.
  3. We always try to call out deprecations and breaking changes in the Notes section of the Release Notes.
  4. Therefore, always read the Notes section of the Release Notes for the major and minor releases.

See https://discuss.gohugo.io/t/upgraded-to-v-0-21-cant-evaluate-field-rsslink/6870

rdwatters commented 7 years ago

@moorereason Are you thinking a whole new page under "Getting Started" or that I just write some copy around what I now realize is a pretty pathetic area of the webpage:

https://hugodocs.info/getting-started/installing/#upgrading-hugo

moorereason commented 7 years ago

I was thinking of a separate page only because it would be in the menu, but it's your call.

rdwatters commented 7 years ago

I think a new page makes the most sense, and for my own notes:

https://github.com/gohugoio/hugo/pull/3620#issuecomment-309866532