Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs: UpgradeScripts #114

Open
tunger opened this issue Jul 13, 2020 · 3 comments
Open

Improve docs: UpgradeScripts #114

tunger opened this issue Jul 13, 2020 · 3 comments

Comments

@tunger
Copy link
Contributor

tunger commented Jul 13, 2020

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.

@PaulStovell
Copy link
Member

PaulStovell commented Aug 20, 2020

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.

@khalidabuhakmeh
Copy link

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

@akirayamamoto
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants