Skip to content
This repository has been archived by the owner on Dec 16, 2024. It is now read-only.

SEO: reword introduction paragraph into descriptions - Part 4 (last) #423

Merged
merged 3 commits into from
Jul 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions source/docs/appendices/migration-guides.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
id: migration-guides
title: Migration Guides
description: This area contains the Migration steps to follow for upgrading your store to new Front-Commerce versions.
---

This area will contain the Migration steps to follow for upgrading your store to new Front-Commerce versions.

Our goal is to make migrations as smooth as possible. This is why we try to make many changes backward compatible by using deprecation warnings. The deprecation warnings are usually removed in the next breaking release.

## `2.14.0` -> `2.15.0`
Expand Down
3 changes: 1 addition & 2 deletions source/docs/appendices/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
id: release-notes
title: Release notes
description: This page lists the public releases and will let you know what is included in each release so you could clearly define an upgrade plan for your project.
---

This page lists the public releases and will let you know what is included in each release so you could clearly define an upgrade plan for your project.

## Latest version

**Front-Commerce [`2.15.0`](#2-15-0-2022-05-12)**
Expand Down
5 changes: 1 addition & 4 deletions source/docs/appendices/release-process.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
---
id: release-process
title: Release process
description: Front-Commerce is built around the motto "Make it work, then make it better". This means that it is possible today to develop and deploy your website to production. This page explains our release philosophy so you know when to upgrade an existing application.
---

Front-Commerce is built around the motto "Make it work, then make it better". This means that it is possible **today** to develop and deploy your website to production.

Our mission of making your life easier, and your customers happier is an ongoing process. Front-Commerce will thus regularly evolve. Our main strength is our flexibility. We do take into account our clients needs and adapt our Roadmap to match theirs. If you have any particular needs, feel free to <span class="intercom-launcher">[contact us](mailto:[email protected])</span> and we will see what we can do to help you :)

This page explains our release philosophy.

## Semantic Versioning

We aim at releasing often and follow [Semantic Versioning](https://semver.org) to clearly communicate our advancements to developers. We document each migration process (changelog, release notes and documentation updates) and add deprecation warnings while keeping backwards compatibility to keep upgrades as seamless as possible.
Expand Down
3 changes: 1 addition & 2 deletions source/docs/appendices/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
id: troubleshooting
title: Troubleshooting
description: This page contains the most common errors you may encounter, along with information that will help to solve them quickly.
---

Over the years, many developers have used Front-Commerce. A learning curve for such a solution exist, and we have detected recurring errors that may be difficult to troubleshoot for developers new to Front-Commerce or starting a new project.

This page contains the most common errors you may encounter, along with information that will help to solve them quickly.

## My server is not starting

> I cannot prepare the application or make it start
Expand Down
1 change: 1 addition & 0 deletions source/docs/reference/analytics-components.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: analytics-components
title: Analytics React Components
description: This reference documentation contains a detailed API interface for you to use when developing a Front-Commerce application.
---

For a tangible example and explanation, please refer to [Analytics](/docs/advanced/theme/analytics.html) advanced documentation.
Expand Down
7 changes: 3 additions & 4 deletions source/docs/reference/cli.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
id: cli
title: CLI
description: With Front-Commerce comes a CLI tool ("front-commerce") that helps you launch the tasks needed to develop, build and launch your application. This reference documentation explains how to use it in a project.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: With Front-Commerce comes a CLI tool ("front-commerce") that helps you launch the tasks needed to develop, build and launch your application. This reference documentation explains how to use it in a project.
description: With Front-Commerce comes a CLI tool ("front-commerce") that helps you launch the tasks needed to develop, build and launch your application. This reference documentation explains how to use it in a project.

---

With Front-Commerce comes a CLI tool (`front-commerce`) that helps you launch the tasks needed to develop, build and launch your application.

These commands should be launched from your project's root directory. This can be done by:

- Using npm scripts (just like [front-commerce-skeleton/package.json](https://gitlab.com/front-commerce/front-commerce-skeleton/blob/main/package.json#L7))
Expand Down Expand Up @@ -72,9 +71,9 @@ Once it is generated, you can launch the application by using `NODE_ENV=producti

This command will launch the Front-Commerce application. There are two modes available:

- `NODE_ENV=development front-commerce start`: launches Front-Commerce application in development mode (hot reloading, linting, etc.).
- `NODE_ENV=development front-commerce start`: launches Front-Commerce application in development mode (hot reloading, linting, etc.).
Please make sure to have launched `front-commerce prepare` beforehand.
- `NODE_ENV=production front-commerce start`: launches Front-Commerce application in production mode (using precompiled code).
- `NODE_ENV=production front-commerce start`: launches Front-Commerce application in production mode (using precompiled code).
Please make sure to have launched `front-commerce build` beforehand.

## `front-commerce styleguide`
Expand Down
6 changes: 2 additions & 4 deletions source/docs/reference/configurations.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
---
id: configurations
title: Configurations
description: This reference documentation is about existing Front-Commerce configuration files.
---

<blockquote class="note">
This documentation is the current state of the configurations available in Front-Commerce. However, our goal is to clean it up to make sure that it is still easily customizable, but also easier to check if your configurations are correct. We will provide a clear migration path and will integrate this change within our 1.0.0 release.

Please refer to the [related gitlab issue (#106)](https://gitlab.com/front-commerce/front-commerce/issues/106) to follow its advancement.

Most configurations in Front-Commerce are now using [Environment variables](/docs/reference/environment-variables.html) and [Configuration providers](/docs/advanced/server/configurations.html). We invite you to also read these related pages.
</blockquote>

## How to set your configurations
Expand Down
2 changes: 1 addition & 1 deletion source/docs/reference/debugging.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: debugging
title: Debugging
description: Debug your Front-Commerce app.
description: This reference documentation explains how to debug your Front-Commerce app using breakpoints.
---

# Debugging
Expand Down
5 changes: 2 additions & 3 deletions source/docs/reference/environment-variables.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
id: environment-variables
title: Environment variables
description: "Environment variables available in Front-Commerce are the configurations that are likely to change depending on the current environment of your application. For instance, you could have three different environments: production, staging, and local."
---

The environment variables available in Front-Commerce are the configurations that are likely to change depending on the current environment of your application. For instance, you could have three different environments: production, staging and local.

These environment variables can be defined in two different ways:
Environment variables documented in this guide can be defined in two different ways:

- on your server (See [How To Read and Set Environmental and Shell Variables on a Linux VPS](https://www.digitalocean.com/community/tutorials/how-to-read-and-set-environmental-and-shell-variables-on-a-linux-vps))
- in the `.env` file in your root folder
Expand Down
5 changes: 2 additions & 3 deletions source/docs/reference/front-commerce-js.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
id: front-commerce-js
title: .front-commerce.js
description: The .front-commerce.js configuration file at the root of a Front-Commerce project is the main entry point defining how an application behaves. This page documents its different configuration keys.
---

The `.front-commerce.js` configuration file at the root of a Front-Commerce project is the main entrypoint defining how an application behaves.

From this definition, Front-Commerce will initialize and register the different pieces composing your application.
From the `.front-commerce.js` definition, Front-Commerce will initialize and register the different pieces composing your application.

## `name`

Expand Down
5 changes: 2 additions & 3 deletions source/docs/reference/front-commerce-prepare.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
id: front-commerce-prepare
title: front-commerce-prepare.js
description: From the front-commerce-prepare.js file, Front-Commerce will call hooks that will let you customize some of those steps. This reference page documents the syntax of the exported module required by Front-Commerce.
---

The `front-commerce-prepare.js` configuration file at the root of any web modules folder.

From this file, Front-Commerce will call hooks that will let you customize some of those steps. Each hook should be exported using the syntax:
The `front-commerce-prepare.js` configuration file should leave at the root of any web modules folder. Front-Commerce supports the keys detailed below:

## `onCreateRoute`

Expand Down
4 changes: 1 addition & 3 deletions source/docs/reference/graphql-context.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
id: graphql-context
title: GraphQL context
description: Front-Commerce’s GraphQL modules can register GraphQL schema extensions and resolvers to actually fetch the data. This page contains the different keys available in the GraphQL context object managed by Front-Commerce.
---

**Front-Commerce’s GraphQL modules** can register GraphQL schema extensions and resolvers to actually fetch the data.
Front-Commerce manages a **context object** and makes it available in the GraphQL schema so resolvers can use it [using standard GraphQL mechanisms](https://graphql.org/learn/execution/#root-fields-resolvers).

<blockquote class="info">
Expand All @@ -12,8 +12,6 @@ Front-Commerce manages a **context object** and makes it available in the GraphQ
page.
</blockquote>

This page contains the different keys available in the GraphQL context object managed by Front-Commerce.

## `loaders`

The `loaders` key contains all the loaders registered by GraphQL modules, from their [`contextEnhancer` module definition method](/docs/reference/graphql-module-definition.html#contextEnhancer-optional).
Expand Down
4 changes: 1 addition & 3 deletions source/docs/reference/graphql-module-definition.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
---
id: graphql-module-definition
title: GraphQL module definition
description: Front-Commerce’s GraphQL modules is the mechanism allowing to extend and override any part of the schema defined by other modules. This reference documentation explains the different configuration keys available.
---

**Front-Commerce’s GraphQL modules** is the mechanism allowing to extend and
override any part of the schema defined by other modules.

<blockquote class="info">
To get started with GraphQL modules, we recommend you to read the [Extend the
GraphQL schema](/docs/essentials/extend-the-graphql-schema.html) documentation
Expand Down
3 changes: 2 additions & 1 deletion source/docs/reference/remote-schema-helpers.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
id: remote-schema-helpers
title: Remote schema helpers
description: This page references the helpers available when creating a Remote GraphQL module.
---

This page references the helpers available when creating a [Remote GraphQL module](/docs/reference/graphql-module-definition.html#executor-optional).
We encourage you to learn more about [Remote GraphQL modules](/docs/reference/graphql-module-definition.html#executor-optional) before reading this page.

## `makeExecutor`

Expand Down
5 changes: 1 addition & 4 deletions source/docs/reference/routing.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
---
id: routing
title: Routing
description: 'In Front-Commerce, the routing relies on two concepts: web modules and files in the "web/theme/routes" directory of your web module. This reference explains how to customize the routes of your application.'
---

In Front-Commerce, the routing relies on two concepts: web modules and the files in `web/theme/routes` of your web module.

In this reference, you will find an exhaustive list about how to customize the routes of your application.

## Which routes are loaded?

Routes are loaded depending on the web modules declared in `.front-commerce.js`. See [`.front-commerce.js::webModules`](/docs/reference/front-commerce-js.html#webModules).
Expand Down
4 changes: 1 addition & 3 deletions source/docs/reference/scripts.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
---
id: scripts
title: Scripts
description: When in production or during deployment, there are some tasks that are better automated. Front-Commerce contains scripts aimed at being used on your server when your application is running. This reference documentation explains how to use them.
---

When in production or during a deployment, there are some tasks that are better automated.
Front-Commerce contains scripts aimed at being used on your server when your application is running.

<blockquote class="warning">
We plan to improve the way scripts are created and used in the future, and allow developers to register custom scripts from their applications.
If interested for more context, please see [#169](https://gitlab.com/front-commerce/front-commerce/issues/169) for further details and do note hesitate to send us feedback about this feature.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
id: use-selected-product-with-configurable-options
title: useSelectedProductWithConfigurableOptions
description: In the 2.10.0 release we refactored product configurable options and homogenized their use by creating useSelectedProductWithConfigurableOptions. This reference documentation explains how to use it.
---

In the 2.10.0 release we refactored product configurable options and homogeneized their use by creating `useSelectedProductWithConfigurableOptions`.

`useSelectedProductWithConfigurableOptions` accepts multiple formats for initial selected options and returns -among other things- an options update function that automatically handles relevant images selection and auto disabling. We believe this hook will be helpful when dealing with configurable product options so here is a small rundown on of it:
When working with product options, we recommend to use `useSelectedProductWithConfigurableOptions`. It accepts multiple formats for initially selected options and returns -among other things- an options update function that automatically handles relevant image selection and auto disabling. We believe this hook will be helpful when dealing with configurable product options so here is a small rundown on it:

### Inputs

Expand Down