docs icon indicating copy to clipboard operation
docs copied to clipboard

(doc) Add info about Maintenance and Support

Open gep13 opened this issue 3 years ago • 5 comments
trafficstars

Description Of Changes

Added a new fragment with information about Mainteance and Support for licensed customers, and how this can impact them when we release a new version of Chocolatey that is no longer compatible with older version of the Chocolatey Components.

This has direct impacts on some customers that may be using a perpetual license.

This fragment has been added to the release notes pages for Chocolatey, Chocolatey Licensed Extension, and the Chocolatey GUI Licensed Extension, but it can be added to others as required.

Motivation and Context

With the release of v1.0.0 of Chocolatey CLI, there was some feedback that this area was as well documented as it could be. This is an attempt to make this area as clear as possible.

Testing

  • [x] I have previewed these changes using the Docker Container or another method before submitting this pull request.

Change Types Made

  • [ ] Minor documentation fix (typos etc.).
  • [x] Major documentation change (refactoring, reformatting or adding documentation to existing page).
  • [ ] New documentation page added.

Change Checklist

  • [ ] Requires a change to menu structure (top or left hand side)/
  • [ ] Menu structure has been updated

Related Issue

N/A

gep13 avatar Apr 06 '22 06:04 gep13

Given the amount of text being included as a snippet here I kinda wonder if we're better off making that a distinct page of its own. As it is, the release notes pages have a fairly lengthy snippet with the dependency information, and adding this means folks will have to scroll a good couple pages' worth before they actually get to the release notes themselves.

I feel like we may be better off mentioning this as a link to a page with the full information rather than an additional snippet on the release notes page. 🤔

vexx32 avatar Apr 07 '22 00:04 vexx32

Given the amount of text being included as a snippet here I kinda wonder if we're better off making that a distinct page of its own. As it is, the release notes pages have a fairly lengthy snippet with the dependency information, and adding this means folks will have to scroll a good couple pages' worth before they actually get to the release notes themselves.

I feel like we may be better off mentioning this as a link to a page with the full information rather than an additional snippet on the release notes page. 🤔

I really don't like this idea because I think a page on it's own just for this doesn't make a lot of sense.

But I do agree that this has now grown arms and legs. A separate page makes sense, or people are going to have to scroll for a long time before getting to what they went to the page for in the first place.

One advantage of adding it as a snippet means it's in front of people right away. Adding it to a separate page means we need to make sure we really call it out clearly.

Can we add this and the text around dependencies at the top of the release notes (in another snippet) to this new page?

pauby avatar Apr 15 '22 08:04 pauby

@pauby @vexx32 I have updated this PR based on your suggestions. Can you please take it for a spin, and let me know what you think? Thanks!

gep13 avatar May 03 '22 10:05 gep13

@pauby @vexx32 just wanted to send a ping on this. Thanks

gep13 avatar May 09 '22 18:05 gep13

@pauby @vexx32 I believe that this is ready for a final review.

gep13 avatar Sep 05 '22 13:09 gep13