1
0
Michael Bromley 2 жил өмнө
parent
commit
044cf373b6

+ 1 - 1
docs/docs/guides/core-concepts/images-assets/index.mdx

@@ -3,7 +3,7 @@ title: "Images & Assets"
 ---
 
 [`Assets`](/reference/typescript-api/entities/asset/) are used to store files such as images, videos, PDFs, etc. Assets can be
-assigned to **products**, **variants** and **collections** by default. By using [custom fields](/guides/concepts/custom-fields/) it is
+assigned to **products**, **variants** and **collections** by default. By using [custom fields](/guides/developer-guide/custom-fields/) it is
 possible to assign assets to other entities. For example, for implementing customer profile images.
 
 The handling of assets in Vendure is implemented in a modular way, allowing you full control over the way assets

+ 1 - 1
docs/docs/guides/developer-guide/strategies-configurable-operations/index.mdx

@@ -322,7 +322,7 @@ a `component` property, and optional properties to configure that component.
 }
 ```
 
-A full description of the available UI components can be found in the [Custom Fields guide](/guides/concepts/custom-fields/#custom-field-ui).
+A full description of the available UI components can be found in the [Custom Fields guide](/guides/developer-guide/custom-fields/#custom-field-ui).
 
 ### Injecting dependencies
 

+ 1 - 1
docs/docs/guides/developer-guide/the-api-layer/index.mdx

@@ -304,7 +304,7 @@ type WishlistItem {
 }
 ```
 
-The `product` field is a [relation](/docs/graphql-api/relations/) to the `Product` type. The `product` field resolver
+The `product` field is a relation to the `Product` type. The `product` field resolver
 would look like this:
 
 ```ts title="src/plugins/wishlist/api/wishlist-item.resolver.ts"

+ 1 - 1
docs/docs/guides/developer-guide/the-service-layer/index.mdx

@@ -18,7 +18,7 @@ Services are generally scoped to a specific domain or entity. For instance, in t
 and a corresponding [`ProductService`](/reference/typescript-api/services/product-service) which contains all the methods for interacting with products.
 
 Here's a simplified example of a the `ProductService`, including an implementation of the `findOne()` method that was
-used in the example in the [previous section](/guides/concepts/the-api-layer/#resolvers):
+used in the example in the [previous section](/guides/developer-guide/the-api-layer/#resolvers):
 
 ```ts title="src/services/product.service.ts"
 import { Injectable } from '@nestjs/common';

+ 1 - 1
docs/docs/guides/developer-guide/worker-job-queue/index.mdx

@@ -167,7 +167,7 @@ which uses an efficient push-based strategy built on Redis.
 
 ### Using Job Queues in a plugin
 
-If you create a [Vendure plugin](/guides/concepts/plugins/) which involves some long-running tasks, you can also make use of the job queue. See the [JobQueue plugin example](/TODO)
+If you create a [Vendure plugin](/guides/developer-guide/plugins/) which involves some long-running tasks, you can also make use of the job queue. See the [JobQueue plugin example](/TODO)
 for a detailed annotated example.
 
 :::info

+ 1 - 1
docs/docs/guides/how-to/configurable-products/index.md

@@ -8,7 +8,7 @@ A "configurable product" is one where aspects can be configured by the customer,
 - A gift message inserted with the packaging
 - An uploaded image to be printed on a t-shirt
 
-In Vendure this is done by defining one or more [custom fields](/guides/developer-guide/custom-fields/) on the [OrderLine](/reference/typescript-api/order/order-line/) entity.
+In Vendure this is done by defining one or more [custom fields](/guides/developer-guide/custom-fields/) on the [OrderLine](/reference/typescript-api/entities/order-line/) entity.
 
 ## Defining custom fields
 

+ 1 - 1
docs/docs/guides/how-to/importing-data/index.md

@@ -265,7 +265,7 @@ Running this script will populate the database with the test data like when you
 
 If you require more control over how your data is being imported - for example if you also need to import data into custom entities, or import customer or order information - you can create your own CLI script to do this: see [Stand-Alone CLI Scripts](/guides/advanced-topics/stand-alone-scripts).
 
-In addition to all of the services available in the [Service Layer](/reference/typescript-api/service-layer/), the following specialized import services are available:
+In addition to all the services available in the [Service Layer](/guides/developer-guide/the-service-layer/), the following specialized import services are available:
 
 * [`ImportParser`](/reference/typescript-api/import-export/import-parser): Used to parse the CSV file into an array of objects.
 * [`FastImporterService`](/reference/typescript-api/import-export/fast-importer-service): Used to create new products & variants in bulk, optimized for speed.

+ 1 - 1
docs/docs/reference/typescript-api/auth/authentication-strategy.md

@@ -17,7 +17,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 An AuthenticationStrategy defines how a User (which can be a Customer in the Shop API or
 and Administrator in the Admin API) may be authenticated.
 
-Real-world examples can be found in the [Authentication guide](/guides/developer-guide/authentication/).
+Real-world examples can be found in the [Authentication guide](/guides/core-concepts/auth/).
 
 :::info
 

+ 33 - 33
docs/docs/reference/typescript-api/import-export/import-parser.md

@@ -14,7 +14,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="152" packageName="@vendure/core" />
 
-Validates and parses CSV files into a data structure which can then be used to created new entities.
+Validates and parses CSV files into a data structure which can then be used to created new entities.
 This is used internally by the <a href='/reference/typescript-api/import-export/importer#importer'>Importer</a>.
 
 ```ts title="Signature"
@@ -29,7 +29,7 @@ class ImportParser {
 
 <MemberInfo kind="method" type={`(input: string | Stream, mainLanguage: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a> = this.configService.defaultLanguageCode) => Promise&#60;<a href='/reference/typescript-api/import-export/import-parser#parseresult'>ParseResult</a>&#60;<a href='/reference/typescript-api/import-export/import-parser#parsedproductwithvariants'>ParsedProductWithVariants</a>&#62;&#62;`}   />
 
-Parses the contents of the [product import CSV file](/guides/developer-guide/importing-product-data/#product-import-format) and
+Parses the contents of the [product import CSV file](/guides/how-to/importing-data/#product-import-format) and
 returns a data structure which can then be used to populate Vendure using the <a href='/reference/typescript-api/import-export/fast-importer-service#fastimporterservice'>FastImporterService</a>.
 
 
@@ -40,15 +40,15 @@ returns a data structure which can then be used to populate Vendure using the <a
 
 <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="45" packageName="@vendure/core" />
 
-The intermediate representation of an OptionGroup after it has been parsed
+The intermediate representation of an OptionGroup after it has been parsed
 by the <a href='/reference/typescript-api/import-export/import-parser#importparser'>ImportParser</a>.
 
 ```ts title="Signature"
 interface ParsedOptionGroup {
-    translations: Array<{
-        languageCode: LanguageCode;
-        name: string;
-        values: string[];
+    translations: Array<{
+        languageCode: LanguageCode;
+        name: string;
+        values: string[];
     }>;
 }
 ```
@@ -57,7 +57,7 @@ interface ParsedOptionGroup {
 
 ### translations
 
-<MemberInfo kind="property" type={`Array&#60;{
         languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>;
         name: string;
         values: string[];
     }&#62;`}   />
+<MemberInfo kind="property" type={`Array&#60;{         languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>;         name: string;         values: string[];     }&#62;`}   />
 
 
 
@@ -69,15 +69,15 @@ interface ParsedOptionGroup {
 
 <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="61" packageName="@vendure/core" />
 
-The intermediate representation of a Facet after it has been parsed
+The intermediate representation of a Facet after it has been parsed
 by the <a href='/reference/typescript-api/import-export/import-parser#importparser'>ImportParser</a>.
 
 ```ts title="Signature"
 interface ParsedFacet {
-    translations: Array<{
-        languageCode: LanguageCode;
-        facet: string;
-        value: string;
+    translations: Array<{
+        languageCode: LanguageCode;
+        facet: string;
+        value: string;
     }>;
 }
 ```
@@ -86,7 +86,7 @@ interface ParsedFacet {
 
 ### translations
 
-<MemberInfo kind="property" type={`Array&#60;{
         languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>;
         facet: string;
         value: string;
     }&#62;`}   />
+<MemberInfo kind="property" type={`Array&#60;{         languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>;         facet: string;         value: string;     }&#62;`}   />
 
 
 
@@ -98,7 +98,7 @@ interface ParsedFacet {
 
 <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="77" packageName="@vendure/core" />
 
-The intermediate representation of a ProductVariant after it has been parsed
+The intermediate representation of a ProductVariant after it has been parsed
 by the <a href='/reference/typescript-api/import-export/import-parser#importparser'>ImportParser</a>.
 
 ```ts title="Signature"
@@ -110,12 +110,12 @@ interface ParsedProductVariant {
     trackInventory: GlobalFlag;
     assetPaths: string[];
     facets: ParsedFacet[];
-    translations: Array<{
-        languageCode: LanguageCode;
-        optionValues: string[];
-        customFields: {
-            [name: string]: string;
-        };
+    translations: Array<{
+        languageCode: LanguageCode;
+        optionValues: string[];
+        customFields: {
+            [name: string]: string;
+        };
     }>;
 }
 ```
@@ -159,7 +159,7 @@ interface ParsedProductVariant {
 
 ### translations
 
-<MemberInfo kind="property" type={`Array&#60;{
         languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>;
         optionValues: string[];
         customFields: {
             [name: string]: string;
         };
     }&#62;`}   />
+<MemberInfo kind="property" type={`Array&#60;{         languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>;         optionValues: string[];         customFields: {             [name: string]: string;         };     }&#62;`}   />
 
 
 
@@ -171,7 +171,7 @@ interface ParsedProductVariant {
 
 <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="102" packageName="@vendure/core" />
 
-The intermediate representation of a Product after it has been parsed
+The intermediate representation of a Product after it has been parsed
 by the <a href='/reference/typescript-api/import-export/import-parser#importparser'>ImportParser</a>.
 
 ```ts title="Signature"
@@ -179,14 +179,14 @@ interface ParsedProduct {
     assetPaths: string[];
     optionGroups: ParsedOptionGroup[];
     facets: ParsedFacet[];
-    translations: Array<{
-        languageCode: LanguageCode;
-        name: string;
-        slug: string;
-        description: string;
-        customFields: {
-            [name: string]: string;
-        };
+    translations: Array<{
+        languageCode: LanguageCode;
+        name: string;
+        slug: string;
+        description: string;
+        customFields: {
+            [name: string]: string;
+        };
     }>;
 }
 ```
@@ -210,7 +210,7 @@ interface ParsedProduct {
 
 ### translations
 
-<MemberInfo kind="property" type={`Array&#60;{
         languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>;
         name: string;
         slug: string;
         description: string;
         customFields: {
             [name: string]: string;
         };
     }&#62;`}   />
+<MemberInfo kind="property" type={`Array&#60;{         languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>;         name: string;         slug: string;         description: string;         customFields: {             [name: string]: string;         };     }&#62;`}   />
 
 
 
@@ -222,7 +222,7 @@ interface ParsedProduct {
 
 <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="125" packageName="@vendure/core" />
 
-The data structure into which an import CSV file is parsed by the
+The data structure into which an import CSV file is parsed by the
 <a href='/reference/typescript-api/import-export/import-parser#importparser'>ImportParser</a> `parseProducts()` method.
 
 ```ts title="Signature"

+ 1 - 1
docs/docs/reference/typescript-api/import-export/importer.md

@@ -33,7 +33,7 @@ class Importer {
 
 <MemberInfo kind="method" type={`(input: string | Stream, ctxOrLanguageCode: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, reportProgress: boolean = false) => Observable&#60;ImportProgress&#62;`}   />
 
-Parses the contents of the [product import CSV file](/guides/developer-guide/importing-product-data/#product-import-format) and imports
+Parses the contents of the [product import CSV file](/guides/how-to/importing-data/#product-import-format) and imports
 the resulting Product & ProductVariants, as well as any associated Assets, Facets & FacetValues.
 
 The `ctxOrLanguageCode` argument is used to specify the languageCode to be used when creating the Products.

+ 1 - 1
docs/docs/reference/typescript-api/import-export/populate.md

@@ -16,7 +16,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 Populates the Vendure server with some initial data and (optionally) product data from
 a supplied CSV file. The format of the CSV file is described in the section
-[Importing Product Data](/guides/developer-guide/importing-product-data).
+[Importing Product Data](/guides/how-to/importing-data/).
 
 If the `channelOrToken` argument is provided, all ChannelAware entities (Products, ProductVariants,
 Assets, ShippingMethods, PaymentMethods etc.) will be assigned to the specified Channel.

+ 1 - 1
docs/docs/reference/typescript-api/services/asset-service.md

@@ -81,7 +81,7 @@ Create an Asset based on a file uploaded via the GraphQL API. The file should be
 using the [GraphQL multipart request specification](https://github.com/jaydenseric/graphql-multipart-request-spec),
 e.g. using the [apollo-upload-client](https://github.com/jaydenseric/apollo-upload-client) npm package.
 
-See the [Uploading Files docs](/guides/developer-guide/uploading-files) for an example of usage.
+See the [Uploading Files docs](/guides/how-to/uploading-files) for an example of usage.
 ### update
 
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateAssetInput) => Promise&#60;<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>&#62;`}   />

+ 1 - 1
packages/core/src/cli/populate.ts

@@ -10,7 +10,7 @@ const loggerCtx = 'Populate';
  * @description
  * Populates the Vendure server with some initial data and (optionally) product data from
  * a supplied CSV file. The format of the CSV file is described in the section
- * [Importing Product Data](/guides/developer-guide/importing-product-data).
+ * [Importing Product Data](/guides/how-to/importing-data/).
  *
  * If the `channelOrToken` argument is provided, all ChannelAware entities (Products, ProductVariants,
  * Assets, ShippingMethods, PaymentMethods etc.) will be assigned to the specified Channel.

+ 1 - 1
packages/core/src/config/auth/authentication-strategy.ts

@@ -9,7 +9,7 @@ import { User } from '../../entity/user/user.entity';
  * An AuthenticationStrategy defines how a User (which can be a Customer in the Shop API or
  * and Administrator in the Admin API) may be authenticated.
  *
- * Real-world examples can be found in the [Authentication guide](/guides/developer-guide/authentication/).
+ * Real-world examples can be found in the [Authentication guide](/guides/core-concepts/auth/).
  *
  * :::info
  *

+ 1 - 1
packages/core/src/data-import/providers/import-parser/import-parser.ts

@@ -156,7 +156,7 @@ export class ImportParser {
 
     /**
      * @description
-     * Parses the contents of the [product import CSV file](/guides/developer-guide/importing-product-data/#product-import-format) and
+     * Parses the contents of the [product import CSV file](/guides/how-to/importing-data/#product-import-format) and
      * returns a data structure which can then be used to populate Vendure using the {@link FastImporterService}.
      */
     async parseProducts(

+ 1 - 1
packages/core/src/data-import/providers/importer/importer.ts

@@ -60,7 +60,7 @@ export class Importer {
 
     /**
      * @description
-     * Parses the contents of the [product import CSV file](/guides/developer-guide/importing-product-data/#product-import-format) and imports
+     * Parses the contents of the [product import CSV file](/guides/how-to/importing-data/#product-import-format) and imports
      * the resulting Product & ProductVariants, as well as any associated Assets, Facets & FacetValues.
      *
      * The `ctxOrLanguageCode` argument is used to specify the languageCode to be used when creating the Products.

+ 1 - 1
packages/core/src/service/services/asset.service.ts

@@ -285,7 +285,7 @@ export class AssetService {
      * using the [GraphQL multipart request specification](https://github.com/jaydenseric/graphql-multipart-request-spec),
      * e.g. using the [apollo-upload-client](https://github.com/jaydenseric/apollo-upload-client) npm package.
      *
-     * See the [Uploading Files docs](/guides/developer-guide/uploading-files) for an example of usage.
+     * See the [Uploading Files docs](/guides/how-to/uploading-files) for an example of usage.
      */
     async create(ctx: RequestContext, input: CreateAssetInput): Promise<CreateAssetResult> {
         return new Promise(async (resolve, reject) => {