From 2fcafb60618f856bb2c14cc33c3fab630f3c338d Mon Sep 17 00:00:00 2001 From: Ivica Batinic Date: Wed, 31 May 2023 12:35:06 +0200 Subject: [PATCH] Update docs --- docs/examples/basic-setup.md | 12 ++++++------ docs/getting-started/defining-models.md | 12 ++++++------ website/i18n/en.json | 12 ++++++++++++ website/sidebars.json | 1 + .../version-2.0.0/examples/basic-setup.md | 12 ++++++------ .../version-2.0.0/getting-started/defining-models.md | 12 ++++++------ .../versioned_sidebars/version-2.0.0-sidebars.json | 1 + 7 files changed, 38 insertions(+), 24 deletions(-) diff --git a/docs/examples/basic-setup.md b/docs/examples/basic-setup.md index 5fb02c1d3..3772e4b30 100644 --- a/docs/examples/basic-setup.md +++ b/docs/examples/basic-setup.md @@ -114,8 +114,8 @@ export class Dog extends Model { } } -Attribute()(Dog, 'breed'); -Attribute()(Dog, 'name'); +Field()(Dog, 'breed'); +Field()(Dog, 'name'); decorate(Dog, { greet: computed, }); @@ -132,10 +132,10 @@ export class Person extends Model { } } -Attribute()(Person, 'id'); -Attribute()(Person, 'age'); -Attribute()(Person, 'name'); -Attribute({ toOne: Dog })(Person, 'favoriteDog'); +Field()(Person, 'id'); +Field()(Person, 'age'); +Field()(Person, 'name'); +Field({ toOne: Dog })(Person, 'favoriteDog'); decorate(Person, { greet: computed, }); diff --git a/docs/getting-started/defining-models.md b/docs/getting-started/defining-models.md index 0485b86d1..d768a9fbc 100644 --- a/docs/getting-started/defining-models.md +++ b/docs/getting-started/defining-models.md @@ -55,9 +55,9 @@ class Pet extends Model { public owner: Person; } -Attribute()(Pet, 'name'); -Attribute({ defaultValue: 0 })(Pet, 'age'); -Attribute({ toOne: Person })(Pet, 'owner'); +Field()(Pet, 'name'); +Field({ defaultValue: 0 })(Pet, 'age'); +Field({ toOne: Person })(Pet, 'owner'); ``` #### JavaScript @@ -69,7 +69,7 @@ class Pet extends Model { static type = 'pet'; } -Attribute()(Pet, 'name'); -Attribute({ defaultValue: 0 })(Pet, 'age'); -Attribute({ toOne: Person })(Pet, 'owner'); +Field()(Pet, 'name'); +Field({ defaultValue: 0 })(Pet, 'age'); +Field({ toOne: Person })(Pet, 'owner'); ``` diff --git a/website/i18n/en.json b/website/i18n/en.json index 49682b32d..f6ae92723 100644 --- a/website/i18n/en.json +++ b/website/i18n/en.json @@ -14,6 +14,9 @@ "api-reference/collection": { "title": "Collection" }, + "api-reference/field": { + "title": "Field" + }, "api-reference/lib-utils": { "title": "Lib utils" }, @@ -114,6 +117,9 @@ "migration-guide/breaking-changes": { "title": "Breaking changes since v1" }, + "migration-guide/codemods": { + "title": "Codemods" + }, "migration-guide/deprecations": { "title": "Deprecations in v2" }, @@ -300,6 +306,9 @@ "version-2.0.0/api-reference/version-2.0.0-collection": { "title": "Collection" }, + "version-2.0.0/api-reference/version-2.0.0-field": { + "title": "Field" + }, "version-2.0.0/api-reference/version-2.0.0-lib-utils": { "title": "Lib utils" }, @@ -392,6 +401,9 @@ "version-2.0.0/migration-guide/version-2.0.0-breaking-changes": { "title": "Breaking changes since v1" }, + "version-2.0.0/migration-guide/version-2.0.0-codemods": { + "title": "Codemods" + }, "version-2.0.0/migration-guide/version-2.0.0-deprecations": { "title": "Deprecations in v2" }, diff --git a/website/sidebars.json b/website/sidebars.json index 557ebc964..860f98296 100644 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -22,6 +22,7 @@ "api-reference/model", "api-reference/view", "api-reference/attribute", + "api-reference/field", "api-reference/bucket", "api-reference/pure-model", "api-reference/model-utils", diff --git a/website/versioned_docs/version-2.0.0/examples/basic-setup.md b/website/versioned_docs/version-2.0.0/examples/basic-setup.md index 4c63e60df..f18f5061e 100644 --- a/website/versioned_docs/version-2.0.0/examples/basic-setup.md +++ b/website/versioned_docs/version-2.0.0/examples/basic-setup.md @@ -115,8 +115,8 @@ export class Dog extends Model { } } -Attribute()(Dog, 'breed'); -Attribute()(Dog, 'name'); +Field()(Dog, 'breed'); +Field()(Dog, 'name'); decorate(Dog, { greet: computed, }); @@ -133,10 +133,10 @@ export class Person extends Model { } } -Attribute()(Person, 'id'); -Attribute()(Person, 'age'); -Attribute()(Person, 'name'); -Attribute({ toOne: Dog })(Person, 'favoriteDog'); +Field()(Person, 'id'); +Field()(Person, 'age'); +Field()(Person, 'name'); +Field({ toOne: Dog })(Person, 'favoriteDog'); decorate(Person, { greet: computed, }); diff --git a/website/versioned_docs/version-2.0.0/getting-started/defining-models.md b/website/versioned_docs/version-2.0.0/getting-started/defining-models.md index bd5fd1032..15f526708 100644 --- a/website/versioned_docs/version-2.0.0/getting-started/defining-models.md +++ b/website/versioned_docs/version-2.0.0/getting-started/defining-models.md @@ -56,9 +56,9 @@ class Pet extends Model { public owner: Person; } -Attribute()(Pet, 'name'); -Attribute({ defaultValue: 0 })(Pet, 'age'); -Attribute({ toOne: Person })(Pet, 'owner'); +Field()(Pet, 'name'); +Field({ defaultValue: 0 })(Pet, 'age'); +Field({ toOne: Person })(Pet, 'owner'); ``` #### JavaScript @@ -70,7 +70,7 @@ class Pet extends Model { static type = 'pet'; } -Attribute()(Pet, 'name'); -Attribute({ defaultValue: 0 })(Pet, 'age'); -Attribute({ toOne: Person })(Pet, 'owner'); +Field()(Pet, 'name'); +Field({ defaultValue: 0 })(Pet, 'age'); +Field({ toOne: Person })(Pet, 'owner'); ``` diff --git a/website/versioned_sidebars/version-2.0.0-sidebars.json b/website/versioned_sidebars/version-2.0.0-sidebars.json index 687b1813c..8a8412e05 100644 --- a/website/versioned_sidebars/version-2.0.0-sidebars.json +++ b/website/versioned_sidebars/version-2.0.0-sidebars.json @@ -23,6 +23,7 @@ "version-2.0.0-api-reference/model", "version-2.0.0-api-reference/view", "version-2.0.0-api-reference/attribute", + "version-2.0.0-api-reference/field", "version-2.0.0-api-reference/bucket", "version-2.0.0-api-reference/pure-model", "version-2.0.0-api-reference/model-utils",