Skip to content

Commit

Permalink
Merge branch 'main' into next-6.6
Browse files Browse the repository at this point in the history
  • Loading branch information
bojanrajh committed Feb 13, 2024
2 parents 1f7d596 + 2455795 commit 6e236ac
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 27 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ nav:
This repository contains general **developer** documentation for Shopware 6 which is served on [developer.shopware.com/docs](https://developer.shopware.com/docs/). However, the primary hub for all our [developer resources](https://developer.shopware.com/) is managed through the [developer portal](https://github.com/shopware/developer-portal) repository.
The developer documentation is organized into sections covering :

- [Concepts](./concepts)
- [Guides](./guides)
- [Products](./products)
- [Resources](./resources)
- [Concepts](./concepts/)
- [Guides](./guides/)
- [Products](./products/)
- [Resources](./resources/)

Refer to its [structure](./index.md) to understand better. Contributions to improve the content are welcome, following the outlined [contribution guidelines](./resources/guidelines/documentation-guidelines/06-doc-process.md). The markdown content undergoes workflow checks for easier maintenance. Further details are outlined below.

Expand All @@ -26,7 +26,7 @@ Refer to its [structure](./index.md) to understand better. Contributions to impr

## Workflows

They are defined in the [`.github/workflows`](./.github/workflows) folder and help the DX team to maintain the documentation. The workflows are triggered by events like `push`, `pull_request`, `schedule` and `workflow_dispatch`. The workflows are used to build, test, and deploy the documentation. If a PR pipeline fails, the PR will be marked as failed, and it won't be possible to merge it. In this case, check the below-mentioned workflows to see what went wrong and where to fix it.
They are defined in the [`.github/workflows`](./.github/workflows/) folder and help the DX team to maintain the documentation. The workflows are triggered by events like `push`, `pull_request`, `schedule` and `workflow_dispatch`. The workflows are used to build, test, and deploy the documentation. If a PR pipeline fails, the PR will be marked as failed, and it won't be possible to merge it. In this case, check the below-mentioned workflows to see what went wrong and where to fix it.

### Grammar and language check

Expand Down Expand Up @@ -57,10 +57,10 @@ The `/docs/assets` folder stores images, videos, and other files linked in markd

Certain files within the `shopware/shopware` repository are duplicated in the `shopware/docs` repository for reference purposes. Any modifications made to the former files will automatically synchronize with the corresponding files in the latter repository by the [`update-adrs`](./.github/workflows/update-adrs.yml) workflow.

| `shopware/shopware` files | `shopware/docs` files |
|-----------------------|-----------------------------|
| [shopware's adr](https://github.com/shopware/shopware/tree/trunk/adr) | [adr folder](./resources/references/adr) |
| [adr assets](https://github.com/shopware/shopware/tree/trunk/adr/assets) | [assets adr folder](./assets/adr) |
| [coding guideline](https://github.com/shopware/shopware/tree/trunk/coding-guidelines/core) | [core](./resources/guidelines/code/core) |
| `shopware/shopware` files | `shopware/docs` files |
|-----------------------|-------------------------------------------|
| [shopware's adr](https://github.com/shopware/shopware/tree/trunk/adr) | [adr folder](./resources/references/adr/) |
| [adr assets](https://github.com/shopware/shopware/tree/trunk/adr/assets) | [assets adr folder](./assets/adr/) |
| [coding guideline](https://github.com/shopware/shopware/tree/trunk/coding-guidelines/core) | [core](./resources/guidelines/code/core) |

> Please create a PR in the [shopware](https://github.com/shopware/shopware/pulls) repository if you want to change something in the above folders.
4 changes: 2 additions & 2 deletions guides/installation/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ You can use these commands to check your actual environment:
* MySQL

* Recommended version: 8.0

* Problematic versions: 8.0.20
* Minimum version: 8.0.17
* Problematic versions: 8.0.20, 8.0.21

* MariaDB

Expand Down
2 changes: 1 addition & 1 deletion products/extensions/b2b-suite/guides/core/entity-acl.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ For example, let's look at the schema part responsible for storing the address a

![acl addresses](../../../../../assets/b2bSuite-core-entityAcl.svg)

As you can see, the addresses (subject) can be allowed in two distinct contexts, either through a *role* or through a *contact*. Inbetween these entities are two *ACL* tables holding the M:N relations.
As you can see, the addresses (subject) can be allowed in two distinct contexts, either through a *role* or through a *contact*. In between these entities are two *ACL* tables holding the M:N relations.
On the left, you see the *ContactRole* table. This table holds the information of which contact is assigned to what roles.

This allows for a single query to select all allowed addresses of a particular user combined from the role and direct assignments.
Expand Down
15 changes: 1 addition & 14 deletions resources/references/upgrades/administration/vue3.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,6 @@ Here is a handpicked selection of external resources. This list provides a handy
- [Vue test utils migration guide](https://test-utils.vuejs.org/migration/)

## Step-by-step guide
::: warning
Depending on when you read this document, you still need to enable the `VUE3` feature flag.
To be safe, enable the `VUE3` feature flag and restart your watcher.
:::

To follow along, you should have the following:

- the latest Shopware `trunk` or an official release candidate
Expand All @@ -64,19 +59,11 @@ To follow along, you should have the following:

Make sure to align your `package.json` dependencies with the [administration](https://github.com/shopware/shopware/blob/trunk/src/Administration/Resources/app/administration/package.json).

### Verify the Admin is using Vue 3

If you evaluate the following expression in the browser dev tools, the value `true` must be returned.

```javascript
Shopware.Application.view.vue3
```

### Check your templates

For your templates to work correctly, perform the following in no specific order:

- Replace all `sw-field` usages with the corresponding [components](https://github.com/shopware/shopware/blob/trunk/src/Administration/Resources/app/administration/src/app/component/form/sw-field/index.js#L16).
- Replace all `sw-field` usages with the corresponding [components](https://github.com/shopware/shopware/blob/6.5.x/src/Administration/Resources/app/administration/src/app/component/form/sw-field/index.js#L16).
- [Check all v-models](https://v3-migration.vuejs.org/breaking-changes/v-model.html)
- [Check event listeners](https://v3-migration.vuejs.org/breaking-changes/v-model.html#_3-x-syntax)
- [Check for deprecated slot syntax](https://eslint.vuejs.org/rules/no-deprecated-slot-attribute.html)
Expand Down

0 comments on commit 6e236ac

Please sign in to comment.