backups/grapevine
1
0
Fork 0
mirror of https://gitlab.computer.surgery/matrix/grapevine.git synced 2025-12-17 07:41:23 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix some minor documentation typos

Browse source 
* Capitalize Conduit and Grapevine
* Replace a "Not" with "Note"
* Change a "Conduit 0.7.0" to "Conduit <0.8.0"
* Expand "db" to "database" and "database schema" as appropriate
This commit is contained in:
Charles Hall 2024-12-11 10:03:17 -08:00
parent daceadb310
commit 554751917a
No known key found for this signature in database
GPG key ID: 7B8E0645816E07CF
2 changed files with 19 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

2
book/SUMMARY.md
View file

@ -2,6 +2,6 @@
* [Introduction](./introduction.md) * [Introduction](./introduction.md)
* [Code of conduct](./code-of-conduct.md) * [Code of conduct](./code-of-conduct.md)
* [Migration to/from conduit](./migration.md) * [Migration to/from Conduit](./migration.md)
* [Contributing](./contributing.md) * [Contributing](./contributing.md)
* [Changelog](./changelog.md) * [Changelog](./changelog.md)

35
book/migration.md
View file

@ -1,12 +1,12 @@
# Migration to/from conduit # Migration to/from Conduit
Before migrating a conduit instance to grapevine, make sure to read through Before migrating a Conduit instance to Grapevine, make sure to read through
all of the breaking changes listed in [the changelog](./changelog.md). all of the breaking changes listed in [the changelog](./changelog.md).
In order to migrate an existing conduit instance to/from grapevine, the In order to migrate an existing Conduit instance to/from Grapevine, the
grapevine config must include `conduit_compat = true`. This parameter cannot Grapevine config must include `conduit_compat = true`. This parameter cannot
currently be modified after creating the database for the first time, so make currently be modified after creating the database for the first time, so make
sure to set it when creating a fresh grapevine instance that you may want to sure to set it when creating a fresh Grapevine instance that you may want to
migrate to a different implementation in the future. migrate to a different implementation in the future.
## Config ## Config
@ -26,11 +26,11 @@ automatically migrating existing configs to the new schema.
## Database ## Database
Grapevine is currently compatible with the Conduit 0.7.0 database format. It is Grapevine is currently compatible with the Conduit 0.7.0 database format. It is
still possible to migrate to or from some newer conduit versions, but it may still possible to migrate to or from some newer Conduit versions, but it may
require manual intervention or break some functionality. require manual intervention or break some functionality.
We plan to add [a migration tool][db-compatibility-mr] to support cleanly We plan to add [a migration tool][db-compatibility-mr] to support cleanly
migrating to or from conduit versions we are not internally compatible with. migrating to or from Conduit versions we are not internally compatible with.
| Is migrating from | to | workable? | | Is migrating from | to | workable? |
|-|-|-| |-|-|-|
@ -46,11 +46,12 @@ migrating to or from conduit versions we are not internally compatible with.
Conduit 0.9.0 includes [a database migration][conduit-db-16-migration] that Conduit 0.9.0 includes [a database migration][conduit-db-16-migration] that
modifies data that Grapevine doesn't read. Grapevine does not currently modifies data that Grapevine doesn't read. Grapevine does not currently
recognize the new db version, and will fail to start against a conduit 0.9.0 recognize the new database schema version, and will fail to start against
database. Grapevine can start and run without issues if the version recorded in a Conduit 0.9.0 database. Grapevine can start and run without issues if the
the db is rolled back from 16 to 13. It is possible to do this by editing the version recorded in the databse is rolled back from 16 to 13. It is possible to
db manually, or by modifying grapevine to change the version. [This do this by editing the database manually, or by modifying Grapevine to change
patch][conduit-db-16-patch] is an example of the latter approach. the version. [This patch][conduit-db-16-patch] is an example of the latter
approach.
[conduit-db-16-migration]: https://gitlab.com/famedly/conduit/-/blob/f8d7ef04e664580e882bac852877b68e7bd3ab1e/src/database/mod.rs#L945 [conduit-db-16-migration]: https://gitlab.com/famedly/conduit/-/blob/f8d7ef04e664580e882bac852877b68e7bd3ab1e/src/database/mod.rs#L945
[conduit-db-16-patch]: https://gitlab.computer.surgery/matrix/grapevine/-/commit/fdaa30f0d670c6f04f4e6be5d193f9146d179d95 [conduit-db-16-patch]: https://gitlab.computer.surgery/matrix/grapevine/-/commit/fdaa30f0d670c6f04f4e6be5d193f9146d179d95
@ -59,11 +60,11 @@ patch][conduit-db-16-patch] is an example of the latter approach.
Conduit 0.8.0 added [a new database table][alias_userid-commit] to track which Conduit 0.8.0 added [a new database table][alias_userid-commit] to track which
users created each room alias. Grapevine does not write to this table, so it is users created each room alias. Grapevine does not write to this table, so it is
not possible to delete aliases created in grapevine through the normal not possible to delete aliases created in Grapevine through the normal
client-server API after migrating to conduit 0.8.0. It is possible to delete client-server API after migrating to Conduit 0.8.0. It is possible to delete
aliases with the `remove-alias` admin command. Not that this issue also applies aliases with the `remove-alias` admin command. Note that this issue also applies
to migrations from conduit 0.7.0 to conduit 0.8.0. to migrations from Conduit <0.8.0 to Conduit 0.8.0.
There are no additional known issues when migrating to conduit 0.9.0. There are no additional known issues when migrating to Conduit 0.9.0.
[alias_userid-commit]: https://gitlab.com/famedly/conduit/-/commit/144d548ef739324ca97db12e8cada60ca3e43e09 [alias_userid-commit]: https://gitlab.com/famedly/conduit/-/commit/144d548ef739324ca97db12e8cada60ca3e43e09