docs: update contribution checklist for v2

2026-09-06 09:51:54 +02:00
2 changed files with 6 additions and 80 deletions
@@ -4,14 +4,14 @@
  <h3>Homarr</h3>
 </div>

-**Thank you for your contribution. Please ensure that your pull request meets the following pull request:**
+**Thank you for your contribution. Please ensure that your pull request meets the following requirements:**

- [ ] Builds without warnings or errors (`pnpm build`, autofix with `pnpm format:fix`)
- [ ] Pull request targets `dev` branch
+- [ ] Relevant checks pass without warnings or errors
+- [ ] Pull request targets the intended base branch (`dev` by default; `release/v2` for v2 release work)
 - [ ] Commits follow the [conventional commits guideline](https://www.conventionalcommits.org/en/v1.0.0/)
- [ ] No shorthand variable names are used (eg. `x`, `y`, `i` or any abbrevation)
- [ ] Documentation is up to date. Create a pull request [here](https://github.com/homarr-labs/documentation/).
- [ ] When using AI; No temp files are checked in, the code style follows the rest of the project
+- [ ] No shorthand variable names are used (for example, `x`, `y`, `i`, or abbreviations)
+- [ ] User-facing changes include matching documentation updates under `apps/docs`
+- [ ] When using AI, no temporary files are checked in and the code style follows the rest of the project

 **When contributing a new integration or widget:**

@@ -1,74 +0,0 @@
---
-title: Upgrade from v1 to v2
-sidebar_position: 2
-tags:
-  - Getting started
-  - Upgrade
-  - Migration
-  - Backup
---
-
-Homarr v2 upgrades the existing v1 database in place. Keep the same data storage, database configuration, and
-`SECRET_ENCRYPTION_KEY`; only change the Homarr image or package version for the first start.
-
-:::danger Back up before starting v2
-
-In Homarr v1, go to **Management → Tools → Backup**, export a backup, and keep the downloaded file somewhere safe
-before starting v2. See [Backup and restore](/docs/management/backup) for details.
-
-:::
-
-## Upgrade
-
-1. Pin the Homarr image to `ghcr.io/homarr-labs/homarr:v2.0.0` for the first v2 start.
-2. Keep the existing `/appdata` mount, database variables, Redis configuration, and `SECRET_ENCRYPTION_KEY` unchanged.
-3. Start one Homarr replica and follow its logs. Startup must reach `Migration complete`; Homarr aborts startup when a
-   database migration fails.
-4. Open Homarr and sign in. Confirm **Management → About** reports v2 before starting additional replicas.
-5. After validation, keep the version pinned or return to your normal stable release policy.
-
-For Docker Compose, the change is limited to the image tag before the usual update:
-
-```yaml
-services:
-  homarr:
-    image: ghcr.io/homarr-labs/homarr:v2.0.0
-```
-
-```sh
-docker compose pull
-docker compose up -d
-docker compose logs --follow homarr
-```
-
-Do not add `-v` when stopping the Compose deployment; that can remove named volumes.
-
-## What v2 migrates
-
-The startup migration:
-
- creates the Custom Widget v2, Assistant, header preference, and branding storage;
- adds Base/Mobile layout roles and left/right board gutters;
- converts legacy Categories and dynamic sections into Containers and rails;
- preserves legacy Custom Widget definitions, encrypted secrets, and board references for explicit migration.
-
-Legacy Custom Widgets are not silently rewritten. In **Management → Custom Widgets**, entries marked
-**Migration required** provide a credential-free migration prompt. Review and test the resulting v2 definition before
-removing the archived v1 version. See [Custom Widgets: Import and Workshop](/docs/management/custom-widgets#import-and-workshop).
-
-## Verify the upgraded instance
-
- Sign in with each enabled authentication method and verify administrator access.
- Open every important board on desktop and mobile. Check Containers, former Categories, rails, item placement, and
-  home-board assignments.
- Test at least one read and one permitted action for each critical integration. Recheck integration and board access
-  for representative Viewer, Editor, and Admin groups.
- Check Docker or Podman endpoints, search engines, uploaded media, trusted certificates, scheduled tasks, WebSockets,
-  and external Redis when used.
- Review every legacy Custom Widget and migrate it only after its v2 preview and requests work.
- Restart Homarr once more and confirm the logs contain no migration, database, Redis, authentication, or task errors.
-
-## Roll back
-
-Use the backup exported before the upgrade if you need to restore your v1 installation. Do not reuse a database that
-v2 has already migrated with v1.