Nevermore icon indicating copy to clipboard operation
Nevermore copied to clipboard

Improve docs: UpgradeScripts

Open tunger opened this issue 4 years ago • 3 comments

The quickstart / documentation doesn't state that one needs to run some queries on the target database in order to use Nevermore.

https://github.com/OctopusDeploy/Nevermore/tree/master/source/Nevermore/UpgradeScripts

I figure it works best when using DbUp. It would be good to mention this in the docs.

tunger avatar Jul 13 '20 10:07 tunger

You're right @tunger. Which solution do you prefer?

  1. Explain that the scripts are needed (docs)
  2. Find a way to not need the scripts (e.g., run it only if the feature is used, but do it automatically?)

With your support for other ID types the upgrade scripts might not even be needed, so I am leaning towards option 2.

PaulStovell avatar Aug 20 '20 10:08 PaulStovell

I would prefer 2. as it is more discoverable for folks getting started with Nevermore.

khalidabuhakmeh avatar Jun 09 '22 14:06 khalidabuhakmeh

I added a section to the docs explaining that one should run the upgrade scripts while we don't have a way to automatically run those scripts.

akirayamamoto avatar Nov 23 '22 04:11 akirayamamoto