diff --git a/docs/setup/v2.md b/docs/setup/v2.md new file mode 100644 index 0000000..868d949 --- /dev/null +++ b/docs/setup/v2.md @@ -0,0 +1,41 @@ +# Gramps 5.2 upgrade guide + +**Gramps 5.2** was released on February 23, 2024. Since it uses a new family tree database schema compared to Gramps 5.1, additional steps are necessary when upgrading Gramps Web to be used with Gramps 5.2. This page describes the necessary steps. + +!!! warning + Note that Gramps Web 2.0 and the updated sync addon have **not been released** yet. You can consult this page for updated information. + +## Overview of the steps + + +This is an overview of the steps required to upgrade. +It also shows which steps are executed by the administrator of the Gramps Web server, the owner of the family tree, and whether it's needed only for users of the [sync addon](user-guide/sync.md) + +Server administrator | Tree owner | Action +----|----|---- +  | ✓ | Back up your family tree +  | ✓ 1 | Synchronize Gramps Web with Gramps Desktop +✓ | | Update Gramps Web +  | ✓ | Update the tree's database schema +  | ✓ 1 | Update Gramps Desktop +  | ✓ 1 | Install the updated Sync Addon +  | ✓ | Back up your family tree +  | ✓ 1 | Synchronize Gramps Web with Gramps Desktop + + +1 Only needed if you synchronize Gramps Web with Gramps Desktop. + +## Overview of the release status + +The following table gives an overview of which components needed for Gramps Web with Gramps 5.2 have been released as of today. + +Component | Released +---|--- +Gramps 5.2.0 | 2024-02-23 +Gramps Web API 2.0 | no +Gramps Web 23.3.0 | no +Gramps Web Sync Addon for Gramps 5.2 | no + +## Detailed steps + +Will be provided later. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 04fdd11..a198ad7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -17,11 +17,13 @@ nav: - Multi-tree setup: multi-tree.md - Frontend customization: frontend-config.md - Update: Update.md + - 2.0 upgrade guide: setup/v2.md - Administration: - Introduction: admin.md - Create owner account: user-guide/owner.md - Import data: user-guide/import.md - Export data: user-guide/export.md + - Manage search index: admin/search.md - Synchronize with Gramps: user-guide/sync.md # # - Command Line Interface: cli.md # - First steps: