Documentation updates for data directory deletion/backup on installing a new version #1541
Conversation
shreyamalviya
requested review from
ilija-lazoroski,
mssalvatore and
VakarisZ
Codecov Report
@@ Coverage Diff @@
## develop #1541 +/- ##
========================================
Coverage 43.45% 43.45%
========================================
Files 480 480
Lines 14285 14285
========================================
Hits 6208 6208
Misses 8077 8077 Continue to review full report at Codecov.
|
mssalvatore
force-pushed
the
1530-docs-use-backup-data-dir
branch
from
963ed50
to
a84ec98
Compare
docs/content/FAQ/_index.md
Outdated
| ## I updated to a new version of the Infection Monkey and I'm being asked to delete my existing data directory. Why? | ||
|
|
||
| The [data directory]({{< ref "/reference/data_directory" >}})contains the | ||
| Infection Monkey's database and other internal | ||
| data. For the new version of Infection Monkey to work flawlessly, a data | ||
| directory with a compatible structure needs to be set up. | ||
|
|
||
| If you would like to save the data gathered from the Monkey's previous runs, | ||
| you can make a backup of your [existing data directory]({{< ref | ||
| "/reference/data_directory" >}}) before deleting it. | ||
|
|
||
| ## How can I use an old data directory? | ||
|
|
||
| To use the data stored in a data directory from an older version, reinstall the | ||
| version of the Monkey Island which matches your data directory's version. Then, | ||
| copy the backup of your old data directory to the [appropriate location]({{< | ||
| ref "/reference/data_directory" >}}). | ||
|
|
There was a problem hiding this comment.
I feel like this info should be in setup. In setup pages of appimage and MSI we should display a link: "If you are installing an Infection Monkey update you might be prompted to delete data directory". This doesn't concern docker, right?
There was a problem hiding this comment.
FAQ is already big, we should reserve it for frequent questions only. Let's move it to FAQ is we actually get asked about this
There was a problem hiding this comment.
Info boxes referencing these FAQs have been added to the Linux and Windows setup pages.
mssalvatore
force-pushed
the
1530-docs-use-backup-data-dir
branch
from
edcc41e
to
a43c1b0
Compare
What does this PR do?
Related to #1114
PR Checklist
Was the CHANGELOG.md updated to reflect the changes?Was the documentation framework updated to reflect the changes?Testing Checklist
Added relevant unit tests?