AMT-Cheif
/
drift
mirror of https://github.com/AMT-Cheif/drift.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add rename hint to all doc pages

This commit is contained in:
Simon Binder 2021-10-10 20:07:14 +02:00
parent 3157d687e5
commit 8161c4a1e8
No known key found for this signature in database
GPG Key ID: 7891917E4147B8C0
3 changed files with 48 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/lib/_style.scss
View File

@ -1,2 +1,7 @@
@import 'variables.scss';
@import '_highlight.scss';
.renamed {
padding: 10px;
background-color: rgba(0, 0, 0, 0.08);
}

12
docs/pages/docs/name.md
View File

@ -7,13 +7,17 @@ template: layouts/docs/single
path: /name
---
Moor has been renamed to `drift`. The reason for this is that, in some parts of the world, moor is used as a derogatory term.
I have not been aware of this when starting this project, but this name does not reflect the inclusivity of the Dart and Flutter communities.
Despite the associated effort, I believe that renaming the project is the right decision.
Moor has been renamed to `drift`. The reason for this is that, in some parts of the world, moor may be used as a derogatery term.
I have not been aware of this when starting this project, but we believe that the current name does not reflect the inclusivity of the Dart and Flutter communities.
Despite the associated effort, renaming the project is the right decision.
Thank you for your understanding!
Until version `5.0.0`, the current `moor` and `moor_generator` packages will continue to work - __no urgent action is necessary__.
All features and fixes to the new `drift` packages will be mirrored in `moor` as well.
At the next breaking release, the `moor` set of packages will be discontinued in favor of `drift` and `drift_dev`.
This page describes how to migrate from the old `moor` package to the new `drift` package.
An automatic tool can make all necessary changes, and this is the recommended approach for all users.
This process can be automated, and we hope that the migration is a matter of minutes for you.
In case of issues with the tool, this page also describes how to manually migrate to the new `drift` packages.
## Automatic migration

34
docs/templates/layouts/docs/baseof.html vendored Normal file
View File

@ -0,0 +1,34 @@
<!doctype html>
<html lang="{{ site.language }}" class="no-js">
<head>
{% include "partials/head" %}
</head>
<body class="td-{{ kind }}">
<header>
{% include "partials/navbar" %}
</header>
<div class="container-fluid td-outer">
<div class="td-main">
<div class="row flex-xl-nowrap">
<div class="col-12 col-md-3 col-xl-2 td-sidebar d-print-none">
{% include "partials/sidebar" %}
</div>
<div class="d-none d-xl-block col-xl-2 td-toc d-print-none">
{% include "partials/toc" %}
</div>
<main class="col-12 col-md-9 col-xl-8 pl-md-5" role="main">
{% if page.path != '/name' %}
<div class="renamed">
<b>Important notice: </b>Moor has been renamed to Drift.
Learn more <a href="{{ '/name/' | relUrl }}">here</a>.
</div>
{% endif %}
{% include "partials/breadcrumb" %}
{{ main }}
</main>
</div>
</div>
{% include "partials/footer" %}
</div>
</body>
</html>